react-flag-icon-css - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

CHANGELOG.md

@@ -0,1 +1,9 @@
+<a name="1.0.5"></a>
+## 1.0.5 (2016-10-06)
+
+* fix(flow): fix FlagIcon and FlagIconFactory annotations ([296940e](https://github.com/matteocng/react-flag-icon-css/commit/296940e))
+* docs(README): update and add new sections ([63ecce5](https://github.com/matteocng/react-flag-icon-css/commit/63ecce5))
+
+
+
 <a name="1.0.4"></a>
@@ -2,0 +10,0 @@ ## 1.0.4 (2016-10-05)

package.json

@@ -5,3 +5,3 @@ {
   "homepage": "https://github.com/matteocng/react-flag-icon-css#readme",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "main": "./lib",
@@ -8,0 +8,0 @@ "author": {

README.md

@@ -1,2 +0,2 @@
-A simple React SVG country flags component.
+A simple React SVG country flags component that works with React Css Modules (default) or global Css.
 
@@ -16,3 +16,3 @@ ## Installation
 ```bash
-$ npm install --save-dev babel-loader css-loader file-loader sass-loader node-sass style-loader extract-text-webpack-plugin classnames tcomb tcomb-react
+$ npm install --save-dev babel-loader css-loader file-loader sass-loader node-sass style-loader extract-text-webpack-plugin classnames tcomb tcomb-react react-css-modules
 ```
@@ -48,25 +48,34 @@
 
-| Prop | Type | Default | Description | Supported values |
-| --- | --- | --- | --- |
-| code * | <code>String</code> |  | [ISO 3166-1-alpha-2 code](http://www.iso.org/iso/country_names_and_code_elements) | The list is [here](relative link/static/countries.json) |
-| size | <code>String</code> |  |  | lg, 2x, 3x, 4x, 5x |
-| flip | <code>String</code> |  |  | horizontal, vertical |
-| rotate | <code>Number</code> |  |  | 30, 60, 90, 180, 270 |
-| squared | <code>Boolean</code> | <code>false</code> |  | |
-| Component | <code>String</code> | <code>span</code> |  | e.g <code>span</code>, <code>div</code> |
-| Children | <code>String</code> | <code>false</code> | React element | e.g ```<Something />``` |
+| Prop | Type | Flow Type | Default | Description | Supported values |
+| --- | --- | --- | --- | --- |  --- |
+| code * | <code>String</code> | <code>FlagIconCodeType</code> | | [ISO 3166-1-alpha-2 code](https://www.iso.org/obp/ui/#searchs) | The list is [here](relative link/static/countries.json) |
+| size | <code>String</code> | <code>FlagIconSizeType</code> | |  | lg, 2x, 3x, 4x, 5x |
+| flip | <code>String</code> | <code>FlagIconFlipType</code> | |  | horizontal, vertical |
+| rotate | <code>Number</code> | <code>FlagIconRotateType</code>| |  | 30, 60, 90, 180, 270 |
+| squared | <code>Boolean</code> | |<code>false</code> |  | |
+| Component | <code>String</code> | |<code>span</code> |  | e.g <code>span</code>, <code>div</code> |
+| Children | <code>String</code> | <code>React$Element<*></code>| | React element | e.g ```<Something />``` |
 
-In development mode, you will see warnings in the console if you attempt to use an unsupported prop value.
+Remember to always build FlagIcon with its factory.
 
+## FlagIconFactory
+
+| Argument | Type | Flow Type | Description | Supported values |
+| --- | --- | --- | --- |  --- |
+| React * | <code>Module</code> | <code>ReactModule</code>  | Your app's React instance | Versions in peerDependencies |
+| options | <code>Object</code> | <code>FlagIconOptionsType</code> |  |  ||
+
 ## Development
 
-TODO
+Runtime type checking: in development mode (process.env.NODE_ENV !== 'production'), if you attempt to use an unsupported prop or prop value, you will see "Failed prop type" errors in the browser console (tcomb package).
 
+Static type checking: if you use Flow, it should automatically pick up this package's definitions from the .js.flow files and check your code accordingly when you run <code>npm run flow</code>. The latest Flow version or the version in package.json is recommended.
+
 ## Contributing
 
-TODO
+Contributions are welcome. Please use a topic branch, follow the [AngularJS commit style guidelines](//github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) and check that <code>npm run prepublish</code> (build, test, type checking, lint ...) returns zero errors before opening a PR. Thanks!
 
-## Origin of the flags
+## Source of the flags
 
-This project uses the [flag-icon-css](github.com/lipis/flag-icon-css) SVG country flags and CSS.
+This project uses [flag-icon-css](//github.com/lipis/flag-icon-css) SVG and Css.
 
@@ -73,0 +82,0 @@ ## License

No alert changes

Improved metrics

Total package byte prevSize

75989

increased by2.22%

Number of lines in readme file

83

increased by12.16%

No dependency changes