Add informations about the fork and publish to NPM

getkey · Jan 13, 2019 · ba8ac1e · ba8ac1e
1 parent 616f4c4
commit ba8ac1e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,13 @@
 # gstatsjs
+
+This is a fork of [eXponenta's gstatsjs](https://github.com/eXponenta/gstatsjs) that can be imported as a ES6 module. Additionally, it can be installed from [NPM](https://www.npmjs.com/package/gstats).
+No other modifications have been made (and none are planned). More informations [here](https://github.com/eXponenta/gstatsjs/pull/2).
+
+```sh
+npm install gstats # for npm users
+yarn add gstats # alternatively, for yarn users
+```
+
 Graphics statistics (Texture count, DrawPasses) for WebGL applications. Capability with [stats.js](https://github.com/mrdoob/stats.js)
 
 # Remarks
@@ -65,4 +74,4 @@ function update() {
 
 ### TypeScript
 
-Go to  [gstats.d.ts](https://github.com/eXponenta/gstatsjs/blob/master/dist/gstats.d.ts)
+Go to  [gstats.d.ts](https://github.com/eXponenta/gstatsjs/blob/master/dist/gstats.d.ts)
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "gstatsjs",
+  "name": "gstats",
   "version": "0.0.1",
   "description": "Show DrawCalls, FPS, Texture Count on PIXI, Phaser projects",
   "module": "dist/main.js",