Skip to content
This repository was archived by the owner on Jun 2, 2024. It is now read-only.

Commit bdde1e0

Browse files
committed
Updates readme
1 parent 3d26c79 commit bdde1e0

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@
1919
</p>
2020

2121
<p align="center">
22-
<a href="#install">Install</a> •
23-
<a href="#usage">Usage</a> •
22+
<a href="#installation">Installation</a> •
23+
<a href="#example-usage">Example usage</a> •
2424
<a href="#api">API</a> •
25-
<a href="#contribute">Contribute</a> •
25+
<a href="#development-setup">Development setup</a> •
26+
<a href="#contributing">Contributing</a> •
2627
<a href="#license">License</a>
2728
</p>
2829

@@ -58,14 +59,14 @@ const Menu = ({ showMenuItems }) => (
5859
### After
5960

6061
```javascript
61-
import { ArrayMap, Show } from 'react-semantics';
62+
import { Map, Show } from 'react-semantics';
6263

6364
const Menu = ({ showMenuItems }) => (
6465
<nav>
6566
<a href="/">Home</a>
6667
<Show when={showMenuItems}>
6768
<ul>
68-
<ArrayMap
69+
<Map
6970
array={['prices', 'contact', 'about']}
7071
render={m => (
7172
<li key={m}>
@@ -79,35 +80,30 @@ const Menu = ({ showMenuItems }) => (
7980
);
8081
```
8182

82-
## Install
83+
## Installation
8384

84-
```
85-
npm install --save react-semantics
85+
```bash
86+
$ npm install react-semantics
8687
```
8788

88-
## Usage
89+
## Example usage
8990

9091
```javascript
92+
import React from 'react';
9193
import { Show } from 'react-semantics';
9294

93-
<Show when={5 === 2 + 2}>
94-
<div>Will only render in 1984</div>
95+
<Show when={5 > 4}>
96+
<div>Render me!</div>
9597
</Show>
9698
```
9799

98100
## API
99101

100102
Coming soon...
101103

102-
## Contribute
103-
104-
```
105-
# Clone repository
106-
$ git clone https://github.com/csvenke/react-semantics.git
107-
108-
# Go into repository
109-
$ cd react-semantics
104+
## Development setup
110105

106+
```bash
111107
# Install dependencies
112108
$ npm install
113109

@@ -118,6 +114,14 @@ npm run test
118114
npm run build
119115
```
120116

117+
## Contributing
118+
119+
1. Fork it
120+
1. Create your feature branch
121+
1. Commit your changes
122+
1. Push to the branch
123+
1. Create a new pull request
124+
121125
## License
122126

123-
MIT
127+
This project is licensed under the MIT License - see the [LICENSE](https://github.com/csvenke/react-semantics/blob/master/LICENSE) file for details.

0 commit comments

Comments
 (0)