@paintswap/estfor-definitions 0.1.9 → 0.1.11

package/README.md

@@ -1,53 +1,133 @@
-# estfor-definitions
-Types and Constants for Estfor
+# Estfor Kingdom Types & Constants (estfor-definitions)
 
-## Build
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/84033732/223739503-c53a888a-443f-4fb5-98a3-d40f94956799.png" height="100"/>
+</p>
 
-    yarn build
+[Estfor Kingdom](https://estfor.com/) `types` and `constants` available for
+[<img src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/JavaScript.svg" height="15"/> Javascript](https://developer.mozilla.org/en-US/docs/Learn/JavaScript),
+[<img src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/TypeScript.svg" height="15"/> TypeScript](https://www.npmjs.com/package/typescript), and
+[ <img src="https://avatars1.githubusercontent.com/u/28916798?s=15" height="15"/> AssemblyScript / <img src="https://raw.githubusercontent.com/jpb06/jpb06/master/icons/WebAssembly.svg" height="15"/> WebAssembly](https://www.npmjs.com/package/assemblyscript).
 
-## Publish to NPM (--access=public needed the first time)
+The items in this library will allow you to interact with Estfor Kingdom via:
 
-    yarn publish
+- Vanilla JS applications
+- React, Angular, and other front end frameworks
+- NodeJS / Typescript back end services
+- AssemblyScript / WebAssembly for use with [The Graph Protocol](https://github.com/graphprotocol/graph-node)'s web3 indexing
 
-## Dev use locally using yarn
+## Usage
+
+To use Estfor Kingdom types and constants in your project, first import the dev dependency:
+
+```shell
+npm install -D @paintswap/estfor-definitions
+```
+
+```shell
+yarn add -D @paintswap/estfor-definitions
+```
+
+Once installed, the `EstforConstants`, `EstforTypes`, and `NONE` type will be exposed. You can then access the individual types from their parent.
+
+```ts
+import { EstforConstants, EstforTypes, NONE } from '@paintswap/estfor-definitions'
+const { LOG } = EstforConstants
+const MAPLE_LOG = EstforConstants.MAPLE_LOG
+```
+
+It is also possible to import specific items directly.
+
+```ts
+import { LOG } from '@paintswap/estfor-definitions/constants'
+import { Skill } from '@paintswap/estfor-definitions/types'
+```
+
+## Development
+
+### Build
+
+```shell
+npm run build
+```
+
+```shell
+yarn build
+```
+
+### Use Locally
+
+#### NPM
 
 From library root:
 
-    yarn link
+```shell
+npm link
+```
 
 From project root:
 
-    yarn link @paintswap/estfor-definitions
+```shell
+npm link @paintswap/estfor-definitions
+```
 
-## Dev use locally using yalc
+#### Yarn
 
 From library root:
 
-    yalc publish
+```shell
+yarn link
+```
 
 From project root:
-  
-    yalc link @paintswap/estfor-definitions
 
-Push live updates to projects (library root)
+```shell
+yarn link @paintswap/estfor-definitions
+```
+
+#### Yalc
+
+Install `yalc`
+
+```shell
+npm install -g yalc@latest
+```
 
-    yarn build
-    yalc push
+```shell
+yarn add -g yalc@latest
+```
+
+From library root:
+
+```shell
+yalc publish
+```
+
+From project root:
 
-## Restore NPM version
+```shell
+yalc add @paintswap/estfor-definitions
+```
 
-    yarn add @paintswap/estfor-definitions
+Use newly published updates to local yalc repository.
 
-## Normal Usage
+```shell
+yalc update
+```
 
-    yarn add @paintswap/estfor-definitions
+Revert to NPM Repository
 
-    import { EstforConstants, EstforTypes } from '@paintswap/estfor-definitions'
-    const { LOG } = EstforConstants
-    const LOG = EstforConstants.LOG
+```shell
+yalc remove @paintswap/estfor-definitions
+yarn add @paintswap/estfor-definitions
+```
 
-Can also do single imports:
+### Publish to NPM (--access=public needed the first time)
 
-    import { LOG } from '@paintswap/estfor-definitions/dist/constants'
-    import { Skill } from '@paintswap/estfor-definitions/dist/types'
+```shell
+npm publish
+```
 
+```shell
+yarn publish
+```

package/package.json

@@ -1,20 +1,22 @@
 {
   "name": "@paintswap/estfor-definitions",
-  "version": "0.1.9",
-  "description": "Types and constants for Estfor",
+  "version": "0.1.11",
+  "description": "Types and constants for Estfor Kingdom",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/PaintSwap/estfor-definitions.git"
   },
   "keywords": [
     "estfor",
+    "estfor kingdom",
+    "javascript",
+    "typescript",
+    "assemblyscript",
+    "webassembly",
     "paintswap",
     "game",
     "web3",
-    "ts",
-    "js",
-    "as",
-    "library"
+    "thegraph"
   ],
   "module": "CommonJS",
   "ascMain": "src/index.ts",
@@ -23,6 +25,8 @@
   "scripts": {
     "build": "yarn build:tsc",
     "build:tsc": "tsc",
+    "build:asc": "asc --target release",
+    "build:asc:debug": "asc --target debug",
     "prepare": "yarn build",
     "version": "git add -A src",
     "postversion": "git push && git push --tags"