docs: update repository README (#172)

Summary:
---------

Adding some more information to the main README. 
`packages/cli` still needs a proper README with all commands listed, but that's not in scope of this PR
This commit is contained in:
Michał Pierzchała authored and GitHub committed 2019-02-15 12:36:46 +01:00
1 parent 7a2ebaf275
commit cdfd2b4bc8
1 file changed
+58 -4
+58 -4
View File
@@ -1,5 +1,59 @@
React Native CLI
================
[![CircleCI branch](https://img.shields.io/circleci/project/github/react-native-community/react-native-cli/master.svg)](https://circleci.com/gh/react-native-community/react-native-cli/tree/master)
# React Native CLI
> Command Line Tools for building your next React Native app
Command Line Interface for React Native.
[![Build Status][build-badge]][build] [![Version][version-badge]][package] [![MIT License][license-badge]][license] [![PRs Welcome][prs-welcome-badge]][prs-welcome]
_Note: CLI has been extracted from core `react-native` as a part of "[Lean Core](https://github.com/facebook/react-native/issues/23313)" effort. Please read [this blog post](https://blog.callstack.io/the-react-native-cli-has-a-new-home-79b63838f0e6) for more details._
## About
This repository contains tools and helpers for React Native projects in form of a CLI. We want to make a couple of things clear for you first:
- this is a monorepo;
- there are currently two CLIs: the actual one called [`@react-native-community/cli`](./packages/cli) that does all the job and global `react-native-cli` which is used as its proxy;
We know it's confusing, but we're actively working to make this indirection gone.
## Creating a new React Native project
To start a new React Native project, you'll need to install a global module [`react-native-cli`](./packages/global-cli) and follow instructions there.
We strongly encourage you to **only use global `react-native-cli` for bootstrapping new projects**. Use local version for everything else.
## Usage in existing React Native project
Once you're inside an existing project, a local `react-native` binary will be available for you to use. Feel free to use Yarn to call it directly.
Example running `start` command in terminal:
```sh
yarn react-native start
# or if you don't use Yarn:
node ./node_modules/.bin/react-native start
```
You can also add npm scripts to call it with whichever package manager you use:
```json5
{
"scripts": {
"start": "react-native start"
}
}
```
## License
Everything inside this repository is [MIT licensed](./LICENSE).
<!-- badges -->
[build-badge]: https://img.shields.io/circleci/project/github/react-native-community/react-native-cli/master.svg?style=flat-square
[build]: https://circleci.com/gh/react-native-community/react-native-cli/tree/master
[version-badge]: https://img.shields.io/npm/v/@react-native-community/cli.svg?style=flat-square
[package]: https://www.npmjs.com/package/@react-native-community/cli.svg
[license-badge]: https://img.shields.io/npm/l/@react-native-community/cli.svg?style=flat-square
[license]: https://opensource.org/licenses/MIT
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs-welcome]: http://makeapullrequest.com