@hirosystems/token-metadata-api-client 1.0.0 → 1.0.1

package/.swagger-codegen-ignore

@@ -1,24 +1,3 @@
-# Swagger Codegen Ignore
-# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
-
-# Use this file to prevent files from being overwritten by the generator.
-# The patterns follow closely to .gitignore or .dockerignore.
-
-# As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
-#ApiClient.cs
-
-# You can match any string of characters against a directory, file or extension with a single asterisk (*):
-#foo/*/qux
-# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
-
-# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
-#foo/**/qux
-# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
-
-# You can also negate patterns with an exclamation (!).
-# For example, you can ignore all files in a docs folder with the file extension .md:
-#docs/*.md
-# Then explicitly reverse the ignore rule for a single file:
-#!docs/README.md
 package.json
+package-lock.json
+README.md

package/README.md

@@ -1,45 +1,19 @@
-## @hirosystems/token-metadata-api-client@1.0.0
+## @hirosystems/token-metadata-api-client
 
-This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
+This is a client library for the [Token Metadata API](https://github.com/hirosystems/token-metadata-api).
 
-Environment
-* Node.js
-* Webpack
-* Browserify
+### Installation
 
-Language level
-* ES5 - you must have a Promises/A+ library installed
-* ES6
-
-Module system
-* CommonJS
-* ES6 module system
-
-It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
-
-### Building
-
-To build an compile the typescript sources to javascript use:
 ```
-npm install
-npm run build
+npm install @hirosystems/token-metadata-api-client
 ```
 
-### Publishing
-
-First build the package then run ```npm publish```
-
-### Consuming
+### Example
 
-navigate to the folder of your consuming project and run one of the following commands.
+```typescript
+import { Configuration, TokensApi } from "@hirosystems/token-metadata-api-client";
 
-_published:_
-
-```
-npm install @hirosystems/token-metadata-api-client@1.0.0 --save
-```
-
-_unPublished (not recommended):_
-
-```
-npm install PATH_TO_GENERATED_PACKAGE --save
+const config: Configuration = {}
+const api = new TokensApi(config);
+const result = await api.getFtMetadata('SP1H1733V5MZ3SZ9XRW9FKYGEZT0JDGEB8Y634C7R.miamicoin-token-v2');
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hirosystems/token-metadata-api-client",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Client for @hirosystems/token-metadata-api",
   "author": "Hiro Systems PBC <engineering@hiro.so> (https://hiro.so)",
   "keywords": [
@@ -12,7 +12,7 @@
   "license": "GPL-3.0",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
-  "scripts" : {
+  "scripts": {
     "build": "tsc --outDir dist/",
     "test": "jest",
     "prepublishOnly": "npm run build"
@@ -34,5 +34,13 @@
       "^.+\\.tsx?$": "ts-jest"
     },
     "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
-    "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
-  }}
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "jsx",
+      "json",
+      "node"
+    ]
+  }
+}