From 75991004698cbcba8a2115e1f62ce793782a1abc Mon Sep 17 00:00:00 2001 From: Dima Vyshniakov Date: Thu, 30 Nov 2023 18:17:52 +0100 Subject: [PATCH] update readme --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 962f585..61f3e2e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,39 @@ # React Library Template -With React Template Repository, you can focus on developing your React components and libraries without worrying about the configuration and setup. +With React Library Template Repository, you can focus on developing your React components and libraries without worrying about the configuration and setup. + +Read [full documentation](https://github.com/morewings/cra-template-npm-library/wiki). + +Visit [Demo Storybook](https://morewings.github.io/cra-template-npm-library). + +## Features + +- Supports **Typescript** and **Javascript**. +- Bundles `commonjs` and `es` module formats. +- [pnpm](https://pnpm.io/) for blazing fast package management. +- [Vite](https://vitejs.dev/) for speedy bundling +- [Husky](https://github.com/typicode/husky) for git hooks. +- [Eslint](https://eslint.org/) and [stylelint](https://stylelint.io/). +- [Rollup](https://rollupjs.org/guide/en/) for bundling. +- [Jest](https://jestjs.io/) and [react-testing-library](https://testing-library.com/docs/react-testing-library/intro) for testing. +- [Storybook](https://storybook.js.org/) for documentation and demo. +- And [much more](https://github.com/morewings/cra-template-npm-library/wiki). + +## Quickstart + +### Prerequisites + +1. Install **Node** >= 18.x. +2. Install **pnpm**. E.g. `corepack prepare pnpm@latest --activate`. + + +### Installation + +Manually clone repo or use `degit`. + +```shell script +npx degit https://github.com/morewings/react-library-template my-library +cd ./my-library +pnpm i +``` +