Skip to content

Commit 6c084bd

Browse files
author
Matthieu Napoli
committed
Improve the README
1 parent 4aa9563 commit 6c084bd

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ The boilerplate provides **an architecture optimized for building solid applicat
88

99
The boilerplate contains:
1010

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`
11+
- a [React Native](https://facebook.github.io/react-native/) application (in "[ejected](https://github.com/react-community/create-react-native-app/blob/master/EJECTING.md)" mode to allow using dependencies that rely on native code)
1212
- a [clear directory layout](#directory-layout) to provide a base architecture for your application
1313
- [Redux](https://redux.js.org/) (v3.7) to help manage state
1414
- [Redux Persist](https://github.com/rt2zz/redux-persist) (v5.9) to persist the Redux state
1515
- [Redux Sagas](https://redux-saga.js.org) (v5.0) to separate side-effects and logic from state and UI logic
16+
- [React Navigation](https://reactnavigation.org/) (v2.12) with a [`NavigationService`](App/Services/NavigationService.js) to handle routing and navigation in the app, with a splash screen setup by default
1617
- [reduxsauce](https://github.com/infinitered/reduxsauce) (v0.7) to facilitate using Redux
1718
- [apisauce](https://github.com/infinitered/apisauce) (v0.15) to make [axios](https://github.com/axios/axios) even better
1819
- [prettier](https://prettier.io/) and [eslint](https://eslint.org/) preconfigured for React Native
19-
- [react-native-navigation](https://reactnavigation.org) (v2.12) with a [`NavigationService`](App/Services/NavigationService.js) for the application's navigation
2020

2121
## Updates
2222

@@ -26,11 +26,11 @@ The boilerplate will follow new React-Native releases as soon as libraries and t
2626

2727
- [`App/Components`](App/Components): presentational components
2828
- [`App/Config`](App/Config): configuration of the application
29-
- [`App/Containers`](App/Containers): container components
29+
- [`App/Containers`](App/Containers): container components, i.e. the application's screens
3030
- [`App/Images`](App/Images): images used by the application
31+
- [`App/Sagas`](App/Sagas): redux sagas
32+
- [`App/Services`](App/Services): application services, e.g. API clients
3133
- [`App/Stores`](App/Stores): redux [actions, reducers and stores](https://redux.js.org/basics)
32-
- [`App/Saga`](App/Sagas): redux sagas
33-
- [`App/Services`](App/Services): application services
3434
- [`App/Theme`](App/Theme): base styles for the application
3535

3636
For more information on each directory, click the link and read the directory's README.
@@ -51,7 +51,7 @@ To create a new project using the boilerplate:
5151
- clone this repository
5252
- remove the previous git history: `rm -rf .git/`
5353
- install the npm dependencies by running `yarn`
54-
- rename the React Native project to your own project name: `npm run rename -- <YourProjectName>` (the default name is `Boilerplate`)
54+
- rename the React Native project to your own project name: `yarn run rename -- <YourProjectName>` (the default name is `Boilerplate`)
5555
- remove the LICENSE file and the "License" section from the README if your project is not open source
5656

5757
Feel free to remove the section "Using the boilerplate" from the README (you will not need it anymore in your project). You are encouraged to keep the rest of the documentation in your project so that it is self-explanatory.

0 commit comments

Comments
 (0)