Skip to content

Commit

Permalink
Merge pull request #75 from jrTilak/dev
Browse files Browse the repository at this point in the history
v1.0.3
  • Loading branch information
Tilak Thapa authored May 12, 2024
2 parents 458477e + 00e47d8 commit 293769e
Show file tree
Hide file tree
Showing 11 changed files with 1,887 additions and 1,587 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ Visit [here](./LICENSE) for license information.
- [NPM Package](https://www.npmjs.com/package/@jrtilak/lazykit)
- [Develop Branch](https://lazykit-www-git-dev-tilak-thapas-projects.vercel.app/)
- [Master Branch](https://lazykit.thapatilak.com.np/)

Thank you for using Lazykit! <3
13 changes: 5 additions & 8 deletions docs/REGISTRY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ This is located at [src/www/src/registry/](../src/www/src/registry/). It is sour
└──[method]
├── index.ts
├── index.test.ts
├── docs.tsx
├── docs.md
├── props.ts
└── *.example.ts
```

Expand All @@ -29,13 +30,9 @@ This is located at [src/www/src/registry/](../src/www/src/registry/). It is sour
- `index.ts`: The source code of the method.
- `index.test.ts`: The test file for the method.
- `*.example.ts`: The example file for the method. At least one example file is required.
- `docs.tsx`: The documentation for the method.
It needs to export the following:
- `default`: The description for the method as a React component.
- `Info`: The additional information for the method as object which contains:
- `description`: The description for the method.
- `externalLinks`: The array of external links for the method. (Optional)
- `Props`: The props for the method as a React component.
- `docs.md`: The documentation for the method.
It shoul have desc as the short description for method and full details description, you can refer the implementation in one of the registry function.
_ `props.ts`: It is a object that includes the details about the propa for the method.

_You can see any of the existing methods for reference._ [here](../src/www/src/registry/)

Loading

0 comments on commit 293769e

Please sign in to comment.