diff --git a/README.md b/README.md index 8183109..ba36705 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ ### Bootstrap -```ts +```tsx npx @ricardo-jrm/supernova ``` @@ -51,30 +51,22 @@ Publish to GitHub (Public)
-### Dev Dependencies - -- `Typescript` -- `React` -- `Prettier` -- `ESLint` -- `Commit Lint` -- `Lint Staged` -- `Husky` -- `Jest` -- `React Testing Library` -- `Storybook` -- `Webpack` -- `Semantic Release` +---
---- +### Project + +- [Project Page](https://www.notion.so/l1b3r/supernova-382adadc317c4ec189b6643bcdfffc09) +- [M0: MVP](https://www.notion.so/l1b3r/M0-MVP-afcf4afd5c054cdb9650f7353780c79a) +- [Source Code](https://github.com/ricardo-jrm/supernova) +- [Releases Page](https://github.com/ricardo-jrm/supernova/releases)
### Install -```ts +```tsx npm install @ricardo-jrm/supernova yarn add @ricardo-jrm/supernova @@ -84,7 +76,13 @@ yarn add @ricardo-jrm/supernova ### Usage -```ts +```tsx +// component +import { + ExampleComponent, + ExampleComponentProps, +} from '@ricardo-jrm/supernova'; + // hook import { useExampleHook, ExampleHookType } from '@ricardo-jrm/supernova'; @@ -95,18 +93,37 @@ import { ExampleContextType, } from '@ricardo-jrm/supernova'; -// component -import { - ExampleComponent, - ExampleComponentProps, -} from '@ricardo-jrm/supernova'; - // provider import { ExampleProvider, ExampleProviderProps } from '@ricardo-jrm/supernova'; ```
+### Project Dependencies + +- TS Package Boilerplate: [🟪 @ricardo-jrm/nova](https://github.com/ricardo-jrm/nova) +- React Module Boilerplate: [🟣 @ricardo-jrm/supernova](https://github.com/ricardo-jrm/supernova) + +
+ +### Dev Dependencies + +- `Yarn` +- `Typescript` +- `React` +- `Prettier` +- `ESLint` +- `Commit Lint` +- `Lint Staged` +- `Husky` +- `Jest` +- `React Testing Library` +- `Storybook` +- `Webpack` +- `Semantic Release` + +
+ ---
diff --git a/package.json b/package.json index 981999a..e7ea402 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@ricardo-jrm/supernova", "description": "React Module Boilerplate", - "version": "0.0.6-development", + "version": "0.0.7-development", "bin": "bin.js", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/components/_Example/index.stories.tsx b/src/components/Example/index.stories.tsx similarity index 100% rename from src/components/_Example/index.stories.tsx rename to src/components/Example/index.stories.tsx diff --git a/src/components/_Example/index.test.tsx b/src/components/Example/index.test.tsx similarity index 100% rename from src/components/_Example/index.test.tsx rename to src/components/Example/index.test.tsx diff --git a/src/components/_Example/index.tsx b/src/components/Example/index.tsx similarity index 100% rename from src/components/_Example/index.tsx rename to src/components/Example/index.tsx diff --git a/src/index.ts b/src/index.ts index 04e6e54..92de1ed 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,5 +1,5 @@ -export { ExampleComponent } from './components/_Example'; -export type { ExampleComponentProps } from './components/_Example'; +export { ExampleComponent } from './components/Example'; +export type { ExampleComponentProps } from './components/Example'; export { useExampleHook } from './hooks/useExampleHook'; export type { ExampleHookType } from './hooks/useExampleHook';