Skip to content
This repository was archived by the owner on Feb 4, 2021. It is now read-only.

Commit 31b9180

Browse files
committed
Update README & package.json with new package details & install details
1 parent b338b70 commit 31b9180

File tree

2 files changed

+33
-14
lines changed

2 files changed

+33
-14
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,38 @@
1-
# Material React Native
1+
# React Native Material Design
22

3-
This is currently a loose fork from the original [mrn](https://github.com/binggg/mrn) repository which is still a work in progress.
3+
React Native components which implement [Material Design](https://www.google.com/design/spec/material-design/introduction.html).
44

5-
Please use the original repository until this is in a stable state.
5+
Credits to **@binggg** for the original [mrn](https://github.com/binggg/mrn) repository.
66

77
## Installation
88

99
```
10-
npm install mrn --save
10+
npm i react-native-material-design --save
1111
```
1212

13-
[Copy the font](https://github.com/oblador/react-native-vector-icons#android) file to your local working directory:
13+
Copy the `MaterialIcons` font file from [react-native-vector-icons](https://github.com/oblador/react-native-vector-icons#android) to your local working directory:
1414

1515
`./node_modules/react-native-vector-icons/Fonts/MaterialIcons.ttf` -> `./android/app/src/main/assets/fonts`.
1616

17+
Import any required components into your project:
18+
19+
```
20+
import { Button, Card } from 'react-native-material-design';
21+
```
22+
23+
> You may need to restart your packager in order for the icons to render.
24+
1725
## React Native 0.16
1826

19-
This library only works with React Native 0.16 due to the breaking changes with Babel and font loading it introduced.
27+
This library only works with React Native 0.16 due to the breaking changes with Babel and font loading it introduced.
28+
29+
## Documentation
30+
31+
Coming soon.
32+
33+
## Contributing
34+
35+
Full contributing guidelines are to be written, however please ensure you follow the points when sending in PRs:
36+
37+
- Ensure no lint warns occur via `npm run lint`.
38+
- Follow the Material Design [guidelines](https://www.google.com/design/spec/layout/metrics-keylines.html#metrics-keylines-baseline-grids).

package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
{
2-
"name": "mrn",
3-
"version": "0.2.0",
2+
"name": "react-native-material-design",
3+
"version": "0.1.0",
44
"description": "React Native Material Design Components",
55
"main": "lib/index.js",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1",
8-
"lint": "./node_modules/.bin/eslint ./lib ./tests"
8+
"lint": "./node_modules/.bin/eslint ./lib"
99
},
1010
"repository": {
1111
"type": "git",
12-
"url": "https://github.com/binggg/mrn.git"
12+
"url": "https://github.com/react-native-material-design/react-native-material-design"
1313
},
1414
"keywords": [
1515
"react-native",
1616
"material",
1717
"design",
1818
"ui",
1919
"components",
20-
"react-component"
20+
"react-component",
21+
"android"
2122
],
22-
"author": "",
2323
"license": "MIT",
2424
"bugs": {
25-
"url": "https://github.com/material-react-native/mrn/issues"
25+
"url": "https://github.com/react-native-material-design/react-native-material-design/issues"
2626
},
27-
"homepage": "https://github.com/material-react-native/mrn",
27+
"homepage": "https://github.com/react-native-material-design/react-native-material-design",
2828
"peerDependencies": {
2929
"react-native": "^0.16.0"
3030
},

0 commit comments

Comments
 (0)