diff --git a/docs/guide/readme.md b/docs/guide/readme.md index d6bbbcd2..54426836 100644 --- a/docs/guide/readme.md +++ b/docs/guide/readme.md @@ -11,7 +11,7 @@ next: /utils/ Install the package with your favorite package manager: ```bash -npm install @studiometa/js-toolkit@alpha +npm install @studiometa/js-toolkit ``` ## Usage diff --git a/package-lock.json b/package-lock.json index b8e5fb0a..7eedba84 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@studiometa/js-toolkit", - "version": "1.0.0-alpha.8", + "version": "1.0.0-alpha.9", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 62bb5135..3c91fda2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@studiometa/js-toolkit", - "version": "1.0.0-alpha.8", + "version": "1.0.0-alpha.9", "description": "", "scripts": { "prepublishOnly": "if [[ ! $PWD =~ dist$ ]]; then echo '🚧 Use `npm run deploy` instead of `npm publish`!' && echo '' && exit 1; fi", @@ -11,7 +11,7 @@ "demo:dev": "cd demo && meta dev", "demo:build": "cd demo && meta build", "build": "rm -rf dist/ && babel --source-maps --out-dir dist/ src/", - "deploy": "npm run build && cp package.json dist/ && cd dist/ && npm publish --tag alpha && rm package.json" + "deploy": "npm run build && cp package.json dist/ && cd dist/ && npm publish && rm package.json" }, "publishConfig": { "access": "public" diff --git a/readme.md b/readme.md index 96bb33c9..e7678751 100644 --- a/readme.md +++ b/readme.md @@ -1,12 +1,20 @@ # JS Toolkit -[![NPM Version](https://img.shields.io/npm/v/@studiometa/js-toolkit/alpha.svg?style=flat-square)](https://www.npmjs.com/package/@studiometa/js-toolkit/v/alpha) +[![NPM Version](https://img.shields.io/npm/v/@studiometa/js-toolkit.svg?style=flat-square)](https://www.npmjs.com/package/@studiometa/js-toolkit/) [![Dependency Status](https://img.shields.io/david/studiometa/js-toolkit.svg?label=deps&style=flat-square)](https://david-dm.org/studiometa/js-toolkit) [![devDependency Status](https://img.shields.io/david/dev/studiometa/js-toolkit.svg?label=devDeps&style=flat-square)](https://david-dm.org/studiometa/js-toolkit?type=dev) ![Codecov](https://img.shields.io/codecov/c/github/studiometa/js-toolkit?style=flat-square) > A set of useful little bits of JavaScript to boost your project! 🚀 -## Installation & usage +## Installation -Have a look at the [small guide](https://js-toolkit.meta.fr/guide/) for information on how to setup a simple map. +Install the latest version via NPM: + +```bash +npm install @studiometa/js-toolkit +``` + +## Usage + +Have a look at the [small guide](https://js-toolkit.meta.fr/guide/) for information on how to use the toolkit.