Skip to content

Commit

Permalink
Replace Starter Kit with doc link (#8682)
Browse files Browse the repository at this point in the history 
* Replace Starter Kit with doc link

* https in Babel link
  • Loading branch information
@gaearon
gaearon committed Jan 4, 2017
1 parent 6076763 commit 0e6f784
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 181 deletions.
5 changes: 0 additions & 5 deletions Gruntfile.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ module.exports = function(grunt) {
'compare_size': require('./grunt/config/compare_size'),
});

grunt.config.set('compress', require('./grunt/config/compress'));

function spawnGulp(args, opts, done) {

grunt.util.spawn({
Expand Down Expand Up @@ -201,15 +199,12 @@ module.exports = function(grunt) {
grunt.registerTask('release:bower', releaseTasks.bower);
grunt.registerTask('release:docs', releaseTasks.docs);
grunt.registerTask('release:msg', releaseTasks.msg);
grunt.registerTask('release:starter', releaseTasks.starter);

grunt.registerTask('release', [
'release:setup',
'clean',
'build',
'release:bower',
'release:starter',
'compress',
'release:docs',
'release:msg',
]);
Expand Down
27 changes: 7 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,32 +27,19 @@ ReactDOM.render(

This example will render "Hello John" into a container on the page.

You'll notice that we used an HTML-like syntax; [we call it JSX](https://facebook.github.io/react/docs/jsx-in-depth.html). JSX is not required to use React, but it makes code more readable, and writing it feels like writing HTML. A simple transform is included with React that allows converting JSX into native JavaScript for browsers to digest.
You'll notice that we used an HTML-like syntax; [we call it JSX](https://facebook.github.io/react/docs/introducing-jsx.html). JSX is not required to use React, but it makes code more readable, and writing it feels like writing HTML. We recommend using [Babel](https://babeljs.io/) with a [React preset](https://babeljs.io/docs/plugins/preset-react/) to convert JSX into native JavaScript for browsers to digest.

## Installation

The fastest way to get started is to serve JavaScript from a CDN. We're using [unpkg](https://unpkg.com/) below but React is also available on [cdnjs](https://cdnjs.com/libraries/react) and [jsdelivr](https://www.jsdelivr.com/projects/react):
React is available as the `react` package on [npm](https://www.npmjs.com/). It is also available on a [CDN](https://facebook.github.io/react/docs/installation.html#using-a-cdn).

```html
<!-- The core React library -->
<script src="https://unpkg.com/react@15.4.0/dist/react.js"></script>
<!-- The ReactDOM Library -->
<script src="https://unpkg.com/react-dom@15.4.0/dist/react-dom.js"></script>
```

We've also built a [starter kit](https://facebook.github.io/react/downloads/react-15.4.0.zip) which might be useful if this is your first time using React. It includes a webpage with an example of using React with live code.

If you'd like to use [bower](http://bower.io), it's as easy as:
React is flexible and can be used in a variety of projects. You can create new apps with it, but you can also gradually introduce it into an existing codebase without doing a rewrite.

```sh
bower install --save react
```

And it's just as easy with [npm](http://npmjs.com):
The recommended way to install React depends on your project. Here you can find short guides for the most common scenarios:

```sh
npm i --save react
```
* [Trying Out React](https://facebook.github.io/react/docs/installation.html#trying-out-react)
* [Creating a Single Page Application](https://facebook.github.io/react/docs/installation.html#creating-a-single-page-application)
* [Adding React to an Existing Application](https://facebook.github.io/react/docs/installation.html#adding-react-to-an-existing-application)

## Contributing

Expand Down
16 changes: 0 additions & 16 deletions grunt/config/compress.js
View file

This file was deleted.

39 changes: 0 additions & 39 deletions grunt/tasks/release.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,6 @@ var BOWER_FILES = [
'react-dom-server.min.js',
];

var EXAMPLES_PATH = 'examples/';
var EXAMPLES_GLOB = [EXAMPLES_PATH + '**/*.*', EXAMPLES_PATH + '**/.babelrc'];

var STARTER_PATH = 'starter/';
var STARTER_GLOB = [STARTER_PATH + '/**/*.*'];

var STARTER_BUILD_PATH = 'build/starter/';

var JS_PATH = 'build/';
var JS_GLOB = [JS_PATH + '/*.js'];

var VERSION;
var VERSION_STRING;

Expand Down Expand Up @@ -98,7 +87,6 @@ function bower() {
}

function docs() {
grunt.file.copy('build/react-' + VERSION + '.zip', 'docs/downloads/react-' + VERSION + '.zip');
grunt.file.copy('build/react.js', 'docs/js/react.js');
grunt.file.copy('build/react-dom.js', 'docs/js/react-dom.js');
}
Expand All @@ -108,7 +96,6 @@ function msg() {
grunt.log.subhead('Release *almost* complete...');
var steps = [
'Still todo:',
'* add starter pack (`git add -f docs/downloads/react-version.zip`) and commit',
'* push this repo with tags',
'* push bower repo with tags',
'* run `npm-publish` in rrm',
Expand All @@ -121,36 +108,10 @@ function msg() {
});
}

function starter() {
// Copy over examples/ to build/starter/examples/
// and starter/ to build/starter/

grunt.file.expand(EXAMPLES_GLOB).forEach(function(file) {
grunt.file.copy(
file,
STARTER_BUILD_PATH + file
);
});

grunt.file.expand(STARTER_GLOB).forEach(function(file) {
grunt.file.copy(
file,
'build/' + file
);
});

grunt.file.expand(JS_GLOB).forEach(function(file) {
grunt.file.copy(
file,
STARTER_BUILD_PATH + file
);
});
}

module.exports = {
setup: setup,
bower: bower,
docs: docs,
msg: msg,
starter: starter,
};
1 change: 0 additions & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@
"grunt-cli": "^0.1.13",
"grunt-compare-size": "^0.4.0",
"grunt-contrib-clean": "^0.6.0",
"grunt-contrib-compress": "^0.14.0",
"gulp": "^3.9.0",
"gulp-babel": "^6.0.0",
"gulp-flatten": "^0.2.0",
Expand Down
11 changes: 0 additions & 11 deletions starter/README.md
View file

This file was deleted.

96 changes: 7 additions & 89 deletions yarn.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,19 +115,6 @@ aproba@^1.0.3:
version "1.0.4"
resolved "https://registry.yarnpkg.com/aproba/-/aproba-1.0.4.tgz#2713680775e7614c8ba186c065d4e2e52d1072c0"

archiver@^0.16.0:
version "0.16.0"
resolved "https://registry.yarnpkg.com/archiver/-/archiver-0.16.0.tgz#bb570346899d0865eb77ed66727ab3c634fc1a50"
dependencies:
async "~1.4.2"
buffer-crc32 "~0.2.1"
glob "~5.0.0"
lazystream "~0.1.0"
lodash "~3.10.0"
readable-stream "~1.0.26"
tar-stream "~1.2.1"
zip-stream "~0.6.0"

archy@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/archy/-/archy-1.0.0.tgz#f9c8c13757cc1dd7bc379ac77b2c62a5c2868c40"
Expand Down Expand Up @@ -268,10 +255,6 @@ async@~0.2.6:
version "0.2.10"
resolved "https://registry.yarnpkg.com/async/-/async-0.2.10.tgz#b6bbe0b0674b9d719708ca38de8c237cb526c3d1"

async@~1.4.2:
version "1.4.2"
resolved "https://registry.yarnpkg.com/async/-/async-1.4.2.tgz#6c9edcb11ced4f0dd2f2d40db0d49a109c088aab"

asynckit@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79"
Expand Down Expand Up @@ -912,7 +895,7 @@ binary-extensions@^1.0.0:
version "1.7.0"
resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-1.7.0.tgz#6c1610db163abfb34edfe42fa423343a1e01185d"

bl@^1.0.0, bl@~1.1.2:
bl@~1.1.2:
version "1.1.2"
resolved "https://registry.yarnpkg.com/bl/-/bl-1.1.2.tgz#fdca871a99713aa00d19e3bbba41c44787a65398"
dependencies:
Expand Down Expand Up @@ -1112,10 +1095,6 @@ bser@^1.0.2:
dependencies:
node-int64 "^0.4.0"

buffer-crc32@~0.2.1:
version "0.2.6"
resolved "https://registry.yarnpkg.com/buffer-crc32/-/buffer-crc32-0.2.6.tgz#612b318074fc6c4c30504b297247a1f91641253b"

buffer-shims@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/buffer-shims/-/buffer-shims-1.0.0.tgz#9978ce317388c649ad8793028c3477ef044a8b51"
Expand Down Expand Up @@ -1364,15 +1343,6 @@ commoner@~0.10.3:
q "^1.1.2"
recast "^0.10.0"

compress-commons@~0.3.0:
version "0.3.0"
resolved "https://registry.yarnpkg.com/compress-commons/-/compress-commons-0.3.0.tgz#97093e2e193f7567fa13203d4b8defcd5971a519"
dependencies:
buffer-crc32 "~0.2.1"
crc32-stream "~0.3.1"
node-int64 "~0.4.0"
readable-stream "~1.0.26"

concat-map@0.0.1:
version "0.0.1"
resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
Expand Down Expand Up @@ -1433,13 +1403,6 @@ coveralls@^2.11.6:
minimist "1.2.0"
request "2.75.0"

crc32-stream@~0.3.1:
version "0.3.4"
resolved "https://registry.yarnpkg.com/crc32-stream/-/crc32-stream-0.3.4.tgz#73bc25b45fac1db6632231a7bfce8927e9f06552"
dependencies:
buffer-crc32 "~0.2.1"
readable-stream "~1.0.24"

"crc32@>= 0.2.2":
version "0.2.2"
resolved "https://registry.yarnpkg.com/crc32/-/crc32-0.2.2.tgz#7ad220d6ffdcd119f9fc127a7772cacea390a4ba"
Expand Down Expand Up @@ -1731,12 +1694,6 @@ encoding@^0.1.11:
dependencies:
iconv-lite "~0.4.13"

end-of-stream@^1.0.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.1.0.tgz#e9353258baa9108965efc41cb0ef8ade2f3cfb07"
dependencies:
once "~1.3.0"

end-of-stream@~0.1.5:
version "0.1.5"
resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-0.1.5.tgz#8e177206c3c80837d85632e8b9359dfe8b2f6eaf"
Expand Down Expand Up @@ -2358,7 +2315,7 @@ glob2base@^0.0.12:
dependencies:
find-index "^0.1.1"

glob@5.x, glob@^5.0.15, glob@^5.0.5, glob@~5.0.0:
glob@5.x, glob@^5.0.15, glob@^5.0.5:
version "5.0.15"
resolved "https://registry.yarnpkg.com/glob/-/glob-5.0.15.tgz#1bc936b9e02f4a603fcc222ecf7633d30b8b93b1"
dependencies:
Expand Down Expand Up @@ -2504,14 +2461,6 @@ grunt-contrib-clean@^0.6.0:
dependencies:
rimraf "~2.2.1"

grunt-contrib-compress@^0.14.0:
version "0.14.0"
resolved "https://registry.yarnpkg.com/grunt-contrib-compress/-/grunt-contrib-compress-0.14.0.tgz#556dae0bed3d8ccd7b4cfcbcc6bbdacdffb2be77"
dependencies:
archiver "^0.16.0"
chalk "^1.0.0"
pretty-bytes "^2.0.1"

grunt-legacy-log-utils@~0.1.1:
version "0.1.1"
resolved "https://registry.yarnpkg.com/grunt-legacy-log-utils/-/grunt-legacy-log-utils-0.1.1.tgz#c0706b9dd9064e116f36f23fe4e6b048672c0f7e"
Expand Down Expand Up @@ -3436,12 +3385,6 @@ lazy-cache@^1.0.3:
version "1.0.4"
resolved "https://registry.yarnpkg.com/lazy-cache/-/lazy-cache-1.0.4.tgz#a1d78fc3a50474cb80845d3b3b6e1da49a446e8e"

lazystream@~0.1.0:
version "0.1.0"
resolved "https://registry.yarnpkg.com/lazystream/-/lazystream-0.1.0.tgz#1b25d63c772a4c20f0a5ed0a9d77f484b6e16920"
dependencies:
readable-stream "~1.0.2"

lcid@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/lcid/-/lcid-1.0.0.tgz#308accafa0bc483a3867b4b6f2b9506251d1b835"
Expand Down Expand Up @@ -3653,7 +3596,7 @@ lodash.templatesettings@^3.0.0:
lodash._reinterpolate "^3.0.0"
lodash.escape "^3.0.0"

lodash@^3.10.0, lodash@^3.2.0, lodash@^3.9.3, lodash@~3.10.0, lodash@~3.10.1:
lodash@^3.10.0, lodash@^3.2.0, lodash@^3.9.3:
version "3.10.1"
resolved "https://registry.yarnpkg.com/lodash/-/lodash-3.10.1.tgz#5bf45e8e49ba4189e17d482789dfd15bd140b7b6"

Expand Down Expand Up @@ -3733,7 +3676,7 @@ marked@^0.3.6:
version "0.3.6"
resolved "https://registry.yarnpkg.com/marked/-/marked-0.3.6.tgz#b2c6c618fccece4ef86c4fc6cb8a7cbf5aeda8d7"

meow@^3.1.0, meow@^3.3.0:
meow@^3.3.0:
version "3.7.0"
resolved "https://registry.yarnpkg.com/meow/-/meow-3.7.0.tgz#72cb668b425228290abbfa856892587308a801fb"
dependencies:
Expand Down Expand Up @@ -3909,7 +3852,7 @@ node-fetch@^1.0.1:
encoding "^0.1.11"
is-stream "^1.0.1"

node-int64@^0.4.0, node-int64@~0.4.0:
node-int64@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b"

Expand Down Expand Up @@ -4222,14 +4165,6 @@ preserve@^0.2.0:
version "0.2.0"
resolved "https://registry.yarnpkg.com/preserve/-/preserve-0.2.0.tgz#815ed1f6ebc65926f865b310c0713bcb3315ce4b"

pretty-bytes@^2.0.1:
version "2.0.1"
resolved "https://registry.yarnpkg.com/pretty-bytes/-/pretty-bytes-2.0.1.tgz#155ec4d0036f41391e7045d6dbe4963d525d264f"
dependencies:
get-stdin "^4.0.1"
meow "^3.1.0"
number-is-nan "^1.0.0"

pretty-format@^18.0.0:
version "18.0.0"
resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-18.0.0.tgz#5f45c59fe2ed6749d46765429679670b08b21137"
Expand Down Expand Up @@ -4345,7 +4280,7 @@ read-pkg@^1.0.0:
normalize-package-data "^2.3.2"
path-type "^1.0.0"

"readable-stream@>=1.0.33-1 <1.1.0-0", readable-stream@~1.0.2, readable-stream@~1.0.24, readable-stream@~1.0.26:
"readable-stream@>=1.0.33-1 <1.1.0-0":
version "1.0.34"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.0.34.tgz#125820e34bc842d2f2aaafafe4c2916ee32c157c"
dependencies:
Expand All @@ -4363,7 +4298,7 @@ read-pkg@^1.0.0:
isarray "0.0.1"
string_decoder "~0.10.x"

readable-stream@^2.0.0, "readable-stream@^2.0.0 || ^1.1.13", readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.1.0:
"readable-stream@^2.0.0 || ^1.1.13", readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.1.0:
version "2.2.2"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.2.2.tgz#a9e6fec3c7dda85f8bb1b3ba7028604556fc825e"
dependencies:
Expand Down Expand Up @@ -4955,15 +4890,6 @@ tar-pack@~3.3.0:
tar "~2.2.1"
uid-number "~0.0.6"

tar-stream@~1.2.1:
version "1.2.2"
resolved "https://registry.yarnpkg.com/tar-stream/-/tar-stream-1.2.2.tgz#9632f23d98fd33d41661bbdec05489120dec6028"
dependencies:
bl "^1.0.0"
end-of-stream "^1.0.0"
readable-stream "^2.0.0"
xtend "^4.0.0"

tar@~2.2.1:
version "2.2.1"
resolved "https://registry.yarnpkg.com/tar/-/tar-2.2.1.tgz#8e4d2a256c0e2185c6b18ad694aec968b83cb1d1"
Expand Down Expand Up @@ -5420,11 +5346,3 @@ yargs@~3.27.0:
os-locale "^1.4.0"
window-size "^0.1.2"
y18n "^3.2.0"

zip-stream@~0.6.0:
version "0.6.0"
resolved "https://registry.yarnpkg.com/zip-stream/-/zip-stream-0.6.0.tgz#ee933aed996fb18b344a91ae3b5d264cec5e812b"
dependencies:
compress-commons "~0.3.0"
lodash "~3.10.1"
readable-stream "~1.0.26"

0 comments on commit 0e6f784

Please sign in to comment.