From 6f2e1fe6c5cca4c458da9007cea355873ae42fe8 Mon Sep 17 00:00:00 2001 From: jclo Date: Thu, 3 Sep 2020 08:17:54 +0200 Subject: [PATCH] Released 1.0.1. --- CHANGELOG.md | 2 +- _dist/README.md | 32 +++++++++++++++++++++++++------- 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 48ed04f..0cc7419 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ ### 1.0.1 (September 3, 2020) * Fixed a few typos and commented the test suite, - * ..., + * Release. ### 1.0.0 (August 27, 2020) diff --git a/_dist/README.md b/_dist/README.md index 1f9ef75..3b68d88 100644 --- a/_dist/README.md +++ b/_dist/README.md @@ -20,6 +20,11 @@ ES6Pakket relies on [Mocha](https://mochajs.org) and [Chai](http://chaijs.com) f ES6Pakket uses [Travis CI](https://travis-ci.org) for continuous integration and [Coveralls.io](https://coveralls.io) to display test coverage. +Nota: +`ES6Pakket` is a fork of the boilerplate [ES6Kadoo](https://www.npmjs.com/package/@mobilabs/kadoo). + + + ## Quick Startup @@ -37,15 +42,28 @@ Or, if you don't have the rights to install es6lib globally, you can install it npm install @mobilabs/es6pakket ``` -Now populate your empty folder and create your first UMD library: +Then, create a `package.json` file that contains at least: + +```json +{ + "name": "MyApp", + "scripts": { + "create": "es6pakket populate --name ${npm_package_name} --author \"${npm_package_writer_name}\" --acronym ${npm_package_writer_acronym} --email ${npm_package_writer_email} --url ${npm_package_writer_url} && npm install" + }, + "writer": { + "name": "John Doe", + "acronym": "jdo", + "email": "jdo@johndoe.com", + "url": "http://www.johndoe.com/" + } +} +``` +Replace `MyApp` by your project name and fill `writer` with your credentials. + +And finally, type in the terminal: ```bash -// populate -es6pakket populate -n myapp -// Or, if you installed the package locally: -./node_modules/.bin/es6pakket populate -n myapp -// Install Node.js packages -npm install +npm run create. ``` Now your folder contains the following files: