Skip to content
This repository has been archived by the owner on Jun 10, 2019. It is now read-only.

Commit

Permalink
(#22) - rename npm package to babel-plugin-async-to-promises
Browse files Browse the repository at this point in the history
  • Loading branch information
marten-de-vries committed Mar 25, 2016
1 parent 8a7af8c commit 03a33a4
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 13 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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"]
});
```

Expand All @@ -107,17 +107,22 @@ 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?
------------------------

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
-------

Expand Down
8 changes: 8 additions & 0 deletions kneden/README.md
Original file line number Diff line number Diff line change
@@ -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)
1 change: 1 addition & 0 deletions kneden/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('babel-plugin-async-to-promises');
26 changes: 26 additions & 0 deletions kneden/package.json
Original file line number Diff line number Diff line change
@@ -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"
}
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 03a33a4

Please sign in to comment.