docs

README.md

@@ -1 +1,42 @@
+# ts-rename-all
+
+![version](https://img.shields.io/github/package-json/v/bisquit/ts-rename-all)
 [![CI](https://github.com/bisquit/ts-rename-all/actions/workflows/ci.yml/badge.svg)](https://github.com/bisquit/ts-rename-all/actions/workflows/ci.yml)
+
+## Install
+
+```sh
+npm i -g @ts-rename-all/cli
+```
+
+```sh
+yarn global add @ts-rename-all/cli
+```
+
+```sh
+pnpm add -g @ts-rename-all/cli
+```
+
+Then run:
+
+```sh
+ts-rename-all
+```
+
+## Documentation
+
+See [documentation](https://bisquit.github.io/ts-rename-all/).
+
+## Packages
+
+| Package                                  | Version Notes                                                                                                                    |
+| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| [@ts-rename-all/core](packages/core)     | <a href="https://www.npmjs.com/package/@ts-rename-all/core"><img src="https://img.shields.io/npm/v/@ts-rename-all/core"></a>     |
+| [@ts-rename-all/cli](packages/cli)       | <a href="https://www.npmjs.com/package/@ts-rename-all/cli"><img src="https://img.shields.io/npm/v/@ts-rename-all/cli"></a>       |
+| [@ts-rename-all/shared](packages/shared) | <a href="https://www.npmjs.com/package/@ts-rename-all/shared"><img src="https://img.shields.io/npm/v/@ts-rename-all/shared"></a> |
+| [vscode-ts-rename-all](packages/vscode)  | ![version](https://img.shields.io/github/package-json/v/bisquit/ts-rename-all?filename=packages%2Fvscode%2Fpackage.json)         |
+|                                          |
+
+## License
+
+[MIT](LICENSE).