Commit 9e1760cdb440b581390169946efdd4c5aadefd34
Readds readme
Rômulo Alves committed on 4/11/2018, 2:33:08 AMParent: af2e5b7c72b16681b7a2544dcf1aa46188dc6a0e
Files changed
| README.md | added |
| README.md | |||
|---|---|---|---|
| @@ -1,0 +1,44 @@ | |||
| 1 … | +# Beaker React Native | ||
| 2 … | +> This project aims to include [Dat](https://datproject.org/) support in mobiles through [React Native](https://facebook.github.io/react-native/) and [Node.js](https://nodejs.org/en/)! | ||
| 3 … | + | ||
| 4 … | +**It's under development** | ||
| 5 … | + | ||
| 6 … | +## How to start | ||
| 7 … | + | ||
| 8 … | +1. Clone the repo: | ||
| 9 … | + | ||
| 10 … | +`git clone git@github.com:romuloalves/beaker-react-native.git` | ||
| 11 … | + | ||
| 12 … | +2. Install the dependencies in the root directory: | ||
| 13 … | + | ||
| 14 … | +`yarn` | ||
| 15 … | + | ||
| 16 … | +3. Install dependencies of Node.js to the device too, in the directory `nodejs-assets/nodejs-project`. | ||
| 17 … | + | ||
| 18 … | +4. Now is just execute! | ||
| 19 … | + | ||
| 20 … | +`react-native run-ios` or `react-native run-android` | ||
| 21 … | + | ||
| 22 … | +## License | ||
| 23 … | + | ||
| 24 … | +MIT License | ||
| 25 … | + | ||
| 26 … | +Copyright (c) 2017 Rômulo Alves | ||
| 27 … | + | ||
| 28 … | +Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| 29 … | +of this software and associated documentation files (the "Software"), to deal | ||
| 30 … | +in the Software without restriction, including without limitation the rights | ||
| 31 … | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| 32 … | +copies of the Software, and to permit persons to whom the Software is | ||
| 33 … | +furnished to do so, subject to the following conditions: | ||
| 34 … | + | ||
| 35 … | +The above copyright notice and this permission notice shall be included in all | ||
| 36 … | +copies or substantial portions of the Software. | ||
| 37 … | + | ||
| 38 … | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| 39 … | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| 40 … | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| 41 … | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| 42 … | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| 43 … | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| 44 … | +SOFTWARE. | ||
Built with git-ssb-web