added readme

TronSocket · Oct 3, 2024 · d8d8e11 · d8d8e11
1 parent 25986eb
commit d8d8e11
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@tronsocket/types",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "type": "module",
     "main": "./src/index.ts",
     "types": "./src/index.ts",

diff --git a/readme.md b/readme.md
@@ -0,0 +1,17 @@
+# TronSocket Types
+
+## Description
+
+This package contains typescript interfaces for the TronSocket API.
+
+## Installation
+
+```bash
+npm install @tronsocket/types
+```
+
+## Example
+
+```typescript	
+import { Transaction } from '@tronsocket/types';
+```