Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Luca Ramundo committed Feb 21, 2018
1 parent db0458c commit afe21f6
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,23 @@

Add a namespace to redux actions in order to have leaner names.

## DO NOT USE THIS PACKAGE, IT STILL IN DEVELOPMENT

## how to install

```
$ npm install --save redux-namespace-actions
```

## how to use it
## how to use it

The goal of this package is to allow shorter and leaner names for redux actions in different files.
Using a name space, you will be able to define scoped action type constants and use them accross your project.

```js
import namespace from "redux-namespace-actions"
// or var namespace = require("redux-namespace-actions")

const action = namespace("MY_NAMESPACE")

const ACTION_TYPE = action("ACTION_TYPE")

```

0 comments on commit afe21f6

Please sign in to comment.