From 03a33a44d00bf21e07a8dd35f471803da0ed3508 Mon Sep 17 00:00:00 2001 From: Marten de Vries Date: Fri, 25 Mar 2016 16:01:37 +0100 Subject: [PATCH] (#22) - rename npm package to babel-plugin-async-to-promises --- README.md | 23 ++++++++++++++--------- kneden/README.md | 8 ++++++++ kneden/index.js | 1 + kneden/package.json | 26 ++++++++++++++++++++++++++ package.json | 8 ++++---- 5 files changed, 53 insertions(+), 13 deletions(-) create mode 100644 kneden/README.md create mode 100644 kneden/index.js create mode 100644 kneden/package.json diff --git a/README.md b/README.md index a6b2ce7..63dab45 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -Kneden -====== +Kneden (babel-plugin-async-to-promises) +======================================= [![Build Status](https://travis-ci.org/marten-de-vries/kneden.svg?branch=master)](https://travis-ci.org/marten-de-vries/kneden) [![Dependency Status](https://david-dm.org/marten-de-vries/kneden.svg)](https://david-dm.org/marten-de-vries/kneden) @@ -17,7 +17,7 @@ that: - produces readable code - even when generator functions are not available? - doesn't come with a runtime your users have to download? -Then look no further! **Kneden** can help you. +Then look no further! **Kneden (babel-plugin-async-to-promises)** can help you. ## Example @@ -55,7 +55,7 @@ for both the input and output **Kneden** takes/produces. ## Installation ```sh -$ npm install kneden +$ npm install babel-plugin-async-to-promises ``` ## Usage @@ -72,21 +72,21 @@ etc.), make sure you transpile them down to valid ES5 code first using the ```json { - "plugins": ["kneden"] + "plugins": ["async-to-promises"] } ``` ### Via CLI ```sh -$ babel --plugins kneden script.js +$ babel --plugins async-to-promises script.js ``` ### Via Node API ```javascript require("babel-core").transform("code", { - plugins: ["kneden"] + plugins: ["async-to-promises"] }); ``` @@ -107,10 +107,12 @@ Unsupported Contributing ------------ +There are a couple of ways to contribute, for example by: + - Reporting test results with your code base -- [Support removing items while iterating for ForInStatement - #18](https://github.com/marten-de-vries/kneden/issues/18) +- Fixing bugs, for a nice starting task see the ones labeled '[good first bug](https://github.com/marten-de-vries/kneden/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+bug%22)'. -Contributions welcome! Just open an issue or PR. +Contributions are very welcome! Just open an issue or PR. What's up with the name? ------------------------ @@ -118,6 +120,9 @@ What's up with the name? It's Dutch for 'to knead'/'to mold' - the program molds ES7 async/await constructs into promises. It seemed applicable. [Pronounciation](https://upload.wikimedia.org/wikipedia/commons/0/0e/Nl-kneden.ogg). +The npm package name is a more descriptive one as explained in +[issue #22](https://github.com/marten-de-vries/kneden/issues/22). + License ------- diff --git a/kneden/README.md b/kneden/README.md new file mode 100644 index 0000000..7314711 --- /dev/null +++ b/kneden/README.md @@ -0,0 +1,8 @@ +Kneden (babel-plugin-async-to-promises) +======================================= + +> Transpile ES7 async/await to vanilla ES6 Promise chains + +This package name is being phased out. Install [babel-plugin-async-to-promises](https://www.npmjs.com/package/babel-plugin-async-to-promises) +instead. For more information see +[issue #22](https://github.com/marten-de-vries/kneden/issues/22) diff --git a/kneden/index.js b/kneden/index.js new file mode 100644 index 0000000..b36edca --- /dev/null +++ b/kneden/index.js @@ -0,0 +1 @@ +module.exports = require('babel-plugin-async-to-promises'); diff --git a/kneden/package.json b/kneden/package.json new file mode 100644 index 0000000..626e001 --- /dev/null +++ b/kneden/package.json @@ -0,0 +1,26 @@ +{ + "name": "kneden", + "version": "1.0.4", + "description": " Transpile ES7 async/await to vanilla ES6 Promise chains", + "repository": "marten-de-vries/kneden", + "author": "Marten de Vries", + "main": "index.js", + "keywords": [ + "es", + "7", + "6", + "babel", + "promise", + "async", + "await", + "promises", + "function", + "functions", + "plugin", + "babel-plugin" + ], + "dependencies": { + "babel-plugin-async-to-promises": "1.0.4" + }, + "license": "ISC" +} diff --git a/package.json b/package.json index 4fdf1b1..385c4e9 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { - "name": "kneden", - "version": "1.0.2", - "description": " Transpile ES7 async/await to vanilla ES6 Promise chains", - "repository": "marten-de-vries/babel-plugin-kneden", + "name": "babel-plugin-async-to-promises", + "version": "1.0.4", + "description": "Transpile ES7 async/await to vanilla ES6 Promise chains", + "repository": "marten-de-vries/kneden", "author": "Marten de Vries", "main": "lib/index.js", "devDependencies": {