chore: added readme and license

stabilityprotocol · Mar 14, 2024 · fc745a5 · fc745a5
1 parent 79d531b
commit fc745a5
Show file tree

Hide file tree

Showing 6 changed files with 1,388 additions and 2 deletions.
diff --git a/packages/config/LICENSE b/packages/config/LICENSE
diff --git a/packages/config/README.md b/packages/config/README.md
@@ -0,0 +1,18 @@
+# Config
+
+A TypeScript library designed to provide straightforward access to the Stability Testnet and Global Trust Network configurations. This package simplifies the process of integrating blockchain network configurations into your projects, offering details like network IDs, names, native currencies, RPC URLs, and smart contract addresses.
+
+## EXAMPLE
+
+```ts
+import { Blockchains, networks } from "@stabilityprotocol/config";
+
+console.log(
+  "Global Trust Network Chain Id:",
+  networks[Blockchains.STABILITY_GTN].id
+);
+```
+
+## License
+
+This library is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
diff --git a/packages/config/package.json b/packages/config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stabilityprotocol/config",
-  "version": "1.0.2",
+  "version": "1.0.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",