Skip to content

Commit 597d7ee

Browse files
author
Matthieu Napoli
committed
#12 Improve the README
1 parent cc96a1d commit 597d7ee

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,24 @@
22

33
This project is a [React Native](https://facebook.github.io/react-native/) boilerplate that can be used to kickstart a mobile application.
44

5-
This boilerplate contains:
5+
The boilerplate provides an architecture optimized for building solid applications through separation of concerns between the UI and business logic.
66

7-
- an empty React Native application created with `react-native init`
7+
## Content
8+
9+
The boilerplate contains:
10+
11+
- an "[ejected](https://github.com/react-community/create-react-native-app/blob/master/EJECTING.md)" React Native application (v0.55) created with `react-native init`
12+
- a [clear directory layout](#directory-layout) to provide a base architecture for your application
13+
- [Redux](https://redux.js.org/) (v3.7) to help manage state
14+
- [Redux Persist](https://github.com/rt2zz/redux-persist) (v5.9) to persist the Redux state
15+
- [Redux Sagas](https://redux-saga.js.org) (v5.0) to separate side-effects and logic from state and UI logic
16+
- [reduxsauce](https://github.com/infinitered/reduxsauce) (v0.7) to facilitate using Redux
17+
- [apisauce](https://github.com/infinitered/apisauce) (v0.15) to make [axios](https://github.com/axios/axios) even better
818
- [prettier](https://prettier.io/) and [eslint](https://eslint.org/) preconfigured for React Native
9-
- a [directory layout](#directory-layout) for organizing the code of the application
19+
20+
## Updates
21+
22+
The boilerplate will follow new React-Native releases as soon as libraries and tools used here are compatible.
1023

1124
## Directory layout
1225

@@ -17,9 +30,18 @@ This boilerplate contains:
1730

1831
For more information on each directory, click the link and read the directory's README.
1932

33+
## Requirements
34+
35+
Node 8 or greater is required. Development for iOS requires Xcode 9 or up and will target iOS 9 and up.
36+
2037
## Installation
2138

22-
Make sure you have installed [everything needed to run React Native](https://facebook.github.io/react-native/docs/getting-started.html), then:
39+
First install all the dependencies required by React Native:
40+
41+
- for [Android development](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies-3)
42+
- for [iOS development](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies)
43+
44+
Then:
2345

2446
- clone this repository
2547
- remove the previous git history: `rm -rf .git/`

0 commit comments

Comments
 (0)