Skip to content

Commit 564daa9

Browse files
committed
Merge branch 'master' into feat/provide-prev-state-slice
2 parents e9ca7ef + 8474cc0 commit 564daa9

19 files changed

+5486
-7024
lines changed

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ npm-debug.log
33
.DS_Store
44
lib
55
es
6+
umd
67
coverage
78
*.tgz
89
examples/**/dist

Diff for: CHANGELOG.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4+
5+
<a name="4.0.3"></a>
6+
## [4.0.3](https://github.com/wbuchwalter/ng-redux/compare/v4.0.1...v4.0.3) (2018-03-18)
7+
8+
9+
10+
<a name="4.0.1"></a>
11+
## [4.0.1](https://github.com/wbuchwalter/ng-redux/compare/v4.0.0...v4.0.1) (2018-02-07)
12+
13+
14+
15+
<a name="4.0.0"></a>
16+
# [4.0.0](https://github.com/wbuchwalter/ng-redux/compare/3.5.2...4.0.0) (2018-02-07)
17+
18+
19+
### Chores
20+
21+
* **build:** makes redux a peerDependency ([187534a](https://github.com/wbuchwalter/ng-redux/commit/187534a))
22+
23+
24+
### Features
25+
26+
* **lib:** added initial populate dispatch ([b94282b](https://github.com/wbuchwalter/ng-redux/commit/b94282b))
27+
* **lib:** fixes bugs with proposed provided-store logic ([745f3c7](https://github.com/wbuchwalter/ng-redux/commit/745f3c7))
28+
* **lib:** provide store functionality ([5bc1583](https://github.com/wbuchwalter/ng-redux/commit/5bc1583))
29+
* **lib:** reverted a change to the store initialization ([8128828](https://github.com/wbuchwalter/ng-redux/commit/8128828))
30+
31+
32+
### BREAKING CHANGES
33+
34+
* **build:** we aren't including redux to our umd build anymore.
35+
36+
Also added back the umd (dist) build since we still need to support it,
37+
but it will be .gitignored
38+
39+
Added some bower support workaround in Readme

Diff for: CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# Contributing to ng-redux
22

3+
## Developing ng-redux
4+
5+
To run the project, simply `npm install`. Then, run tests via `npm run test` or build the entire project via `npm build`.
6+
7+
## Commit convention
8+
9+
ng-redux uses [`standard-version` convention](https://github.com/conventional-changelog/standard-version) which basically looks like this:
10+
11+
```bash
12+
typeOfCommit(locationOfChanges): Commit message
13+
```
14+
15+
Examples:
16+
17+
```bash
18+
fix(lib): Fix ng-redux library issue
19+
feat(build): Build system test watch
20+
```
21+
22+
And so on. The commits are then compiled into the changelog along with each release.
23+
324
## Release process
425

526
For any contributors with release rights:

Diff for: README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ For Angular 2 see [ng2-redux](https://github.com/wbuchwalter/ng2-redux).
55

66
[![build status](https://img.shields.io/travis/angular-redux/ng-redux/master.svg?style=flat-square)](https://travis-ci.org/ng-redux/ng-redux)
77
[![npm version](https://img.shields.io/npm/v/ng-redux.svg?style=flat-square)](https://www.npmjs.com/package/ng-redux)
8+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)
89

910

1011
*ngRedux lets you easily connect your angular components with Redux.*
@@ -23,22 +24,32 @@ For Angular 2 see [ng2-redux](https://github.com/wbuchwalter/ng2-redux).
2324

2425
## Installation
2526
#### npm
27+
2628
```js
2729
npm install --save ng-redux
2830
```
31+
2932
#### bower (deprecated)
30-
**Warning!** ng-redux will stop being published to bower when version 4.0.0 hits. Bower recommends using yarn and webpack as an alternative for new projects.
33+
**Warning!** Starting with 4.0.0, we will no longer be publishing new releases on Bower. You can continue using Bower for old releases, or point your bower config to the UMD build hosted on unpkg that mirrors our npm releases.
3134

32-
```js
33-
bower install --save ng-redux
35+
```json
36+
{
37+
"dependencies": {
38+
"ng-redux": "https://unpkg.com/ng-redux/umd/ng-redux.min.js"
39+
}
40+
}
3441
```
3542

3643
Add the following script tag to your html:
37-
3844
```html
3945
<script src="bower_components/ng-redux/dist/ng-redux.js"></script>
4046
```
4147

48+
Or directly from unpkg
49+
```html
50+
<script src="https://unpkg.com/ng-redux/umd/ng-redux.min.js"></script>
51+
```
52+
4253
## Quick Start
4354

4455
#### Initialization
@@ -124,7 +135,7 @@ Creates the Redux store, and allow `connect()` to access it.
124135
#### Arguments:
125136
* `reducer` \(*Function*): A single reducer composed of all other reducers (create with redux.combineReducer)
126137
* [`middlewares`] \(*Function[]*): Optional, An array containing all the middleware that should be applied. Functions and strings are both valid members. String will be resolved via Angular, allowing you to use dependency injection in your middlewares.
127-
* [`storeEnhancers`] \(*Function[]*): Optional, this will be used to create the store, in most cases you don't need to pass anything, see [Store Enhancer official documentation.](http://rackt.github.io/redux/docs/Glossary.html#store-enhancer)
138+
* [`storeEnhancers`] \(*Function[]*): Optional, this will be used to create the store, in most cases you don't need to pass anything, see [Store Enhancer official documentation.](https://github.com/reactjs/redux/blob/master/docs/Glossary.md#store-enhancer)
128139
* [`initialState`] \(*Object*): Optional, the initial state of your Redux store.
129140

130141

Diff for: bower.json

-23
This file was deleted.

Diff for: commitlint.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['@commitlint/config-conventional'],
3+
};

0 commit comments

Comments
 (0)