update readme

.eslintrc.cjs

@@ -7,6 +7,11 @@ module.exports = {
     sourceType: 'module',
     project: './tsconfig.linter.json',
   },
+  settings: {
+    react: {
+      version: 'detect'
+    },
+  },
   extends: [
     'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
@@ -118,23 +123,6 @@ module.exports = {
         ],
       },
     },
-    /* Disable `environment` directory imports for library files */
-    {
-      files: ['./src/lib/**/*.*'],
-      rules: {
-        'no-restricted-imports': [
-          'error',
-          {
-            patterns: [
-              {
-                "group": ['**/environment/**'],
-                "message": "Imports from environment directory are forbidden in the library files."
-              }
-            ],
-          },
-        ]
-      }
-    }
   ],
 };
 

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
+```
+

package.json

@@ -38,7 +38,7 @@
     "clean:lib": "rm -rf dist",
     "build:lib": "vite build",
     "build": "run-s clean:lib build:lib",
-    "lint:code": "eslint . --ext ts,tsx --report-unused-disable-directives",
+    "lint:code": "eslint ./src/ --ext ts,tsx --report-unused-disable-directives",
     "fix:code": "run-s 'lint:code --fix'",
     "lint:types": "tsc --pretty --noEmit",
     "lint:style": "stylelint ./src/**/*.css",

tsconfig.linter.json

@@ -1,5 +1,5 @@
 {
   "extends" : "./tsconfig.json",
-  "include": ["**/*.stories.tsx", "**/*.stories.ts", "vite.config.ts", "src"],
-  "exclude": []
+  "include": ["**/*.stories.tsx", "**/*.stories.ts", "*.config.ts", "src"],
+  "exclude": ["./dist/**"]
 }