From d3a63d934503467aba414016c94db32d8bd83ab6 Mon Sep 17 00:00:00 2001
From: Sang Huynh Thanh <sanghuynh20000@gmail.com>
Date: Thu, 25 Jan 2024 10:54:25 +0700
Subject: [PATCH] [#56] Update README

---
 README.md                                     |  3 +-
 .../eslint-config-nimble-typescript/LICENSE   | 19 ++++++
 .../eslint-config-nimble-typescript/README.md | 58 ++++++++++++++++++-
 3 files changed, 76 insertions(+), 4 deletions(-)
 create mode 100644 packages/eslint-config-nimble-typescript/LICENSE

diff --git a/README.md b/README.md
index 55b0584..3dda961 100644
--- a/README.md
+++ b/README.md
@@ -7,8 +7,9 @@
 The configurations are separated into dedicated packages:
 
 - [eslint-config-nimble-core](/packages/eslint-config-nimble-core): ESLint core base rules
-- [eslint-config-nimble-testing](/packages/eslint-config-nimble-testing): ESLint testing base rules
 - [eslint-config-nimble-react](/packages/eslint-config-nimble-react): ESLint rules for React
+- [eslint-config-nimble-testing](/packages/eslint-config-nimble-testing): ESLint rules for testing
+- [eslint-config-nimble-typescript](/packages/eslint-config-nimble-react): ESLint rules for typescript
 
 __Usage information is in the packages' documentation.__
 
diff --git a/packages/eslint-config-nimble-typescript/LICENSE b/packages/eslint-config-nimble-typescript/LICENSE
new file mode 100644
index 0000000..ccfc746
--- /dev/null
+++ b/packages/eslint-config-nimble-typescript/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2021 and onwards Nimble.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/packages/eslint-config-nimble-typescript/README.md b/packages/eslint-config-nimble-typescript/README.md
index 1b28313..61f93b2 100644
--- a/packages/eslint-config-nimble-typescript/README.md
+++ b/packages/eslint-config-nimble-typescript/README.md
@@ -1,11 +1,63 @@
 # `@nimblehq/eslint-config-nimble-typescript`
 
-> TODO: description
+This package provides ESLint typescript rules inheriting from @nimblehq/eslint-config-nimble-core.
+
+## Installation
+
+```bash
+  npm install --save-dev @nimblehq/eslint-config-nimble-typescript
+```
 
 ## Usage
 
+### Standalone
+
+Add `@nimblehq/eslint-config-nimble-typescript` to the extends section of your `.eslintrc` configuration file.
+
+```js
+{
+  "extends": [
+      "@nimblehq/eslint-config-nimble-typescript"
+  ],
+  "rules": {
+    // Additional, per-project rules...
+  }
+}
 ```
-const eslintConfigNimbleTypescript = require('@nimblehq/eslint-config-nimble-typescript');
 
-// TODO: DEMONSTRATE API
+### With a framework
+
+Similar to the process above, but usually it requires adding the extra rules for the JS framework:
+
+```js
+{
+  "extends": [
+      "@nimblehq/eslint-config-nimble-testing",
+      "plugin:react/recommended",
+      "plugin:vue/recommended"
+  ],
+  "rules": {
+    // Additional, per-project rules...
+  }
+}
 ```
+
+This would require defining the required dependencies in the project itself.
+
+## License
+
+This project is Copyright (c) 2021 and onwards Nimble. It is free software and may be redistributed under the terms specified in the [LICENSE] file.
+
+[LICENSE]: /LICENSE
+
+## About
+
+![Nimble](https://assets.nimblehq.co/logo/dark/logo-dark-text-160.png)
+
+This project is maintained and funded by [Nimble](https://nimblehq.co).
+
+We love open source and do our part in sharing our work with the community!
+See [our other projects][community] or [hire our team][hire] to help build your product.
+
+[community]: https://github.com/nimblehq
+[hire]: https://nimblehq.co/