Create README

SAKANA7 · Mar 10, 2022 · 11d4b11 · 11d4b11
1 parent 68ff645
commit 11d4b11
Showing 1 changed file with 37 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,37 @@
+# React Library Starter
+
+This project is a boilerplate for a React UI library.
+
+## What is inside?
+
+- [TypeScript](https://www.typescriptlang.org/)
+- [Styled Components](https://styled-components.com/)
+- [Storybook](https://storybook.js.org/)
+- [Eslint](https://eslint.org/)
+- [Prettier](https://prettier.io/)
+
+## Available commands
+
+- `build`: build the files in the `lib` directory
+- `storybook`: run the storybook at the address `localhost:6006`
+- `prettier:check`: check formatting on all `src` directory
+- `prettier:format`: formats all `src` directory
+
+## Project structure
+
+```
+/.storybook
+/lib
+/src
+├── index.ts
+├── packages
+|   ├── index.ts
+|   ├── Button
+|   |   ├── index.tsx
+|   |   ├── stories.tsx
+|   |   └── styles.ts
+├── styles
+|   ├── global.ts
+|   ├── theme.ts
+```
+