Replace Starter Kit with doc link (#8682)
* Replace Starter Kit with doc link * https in Babel link
Dan Abramov committed
Jan 4, 2017 at 09:39 UTC
0e6f78425977a0446cb3b9ef483b0aff7a6f8c10
7 files changed
+14
-181
Gruntfile.js
-5
@@ -23,8 +23,6 @@ module.exports = function(grunt) {
23
'compare_size': require('./grunt/config/compare_size'),
24
});
25
26
- grunt.config.set('compress', require('./grunt/config/compress'));
27
-
26
function spawnGulp(args, opts, done) {
27
28
grunt.util.spawn({
@@ -201,15 +199,12 @@ module.exports = function(grunt) {
199
grunt.registerTask('release:bower', releaseTasks.bower);
200
grunt.registerTask('release:docs', releaseTasks.docs);
201
grunt.registerTask('release:msg', releaseTasks.msg);
204
- grunt.registerTask('release:starter', releaseTasks.starter);
202
203
grunt.registerTask('release', [
204
'release:setup',
205
'clean',
206
'build',
207
'release:bower',
211
- 'release:starter',
212
- 'compress',
208
'release:docs',
209
'release:msg',
210
]);
README.md
+7
-20
@@ -27,32 +27,19 @@ ReactDOM.render(
27
28
This example will render "Hello John" into a container on the page.
29
30
-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.
30
+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.
31
32
## Installation
33
34
-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):
34
+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).
35
36
-```html
37
-<!-- The core React library -->
38
-<script src="https://unpkg.com/react@15.4.0/dist/react.js"></script>
39
-<!-- The ReactDOM Library -->
40
-<script src="https://unpkg.com/react-dom@15.4.0/dist/react-dom.js"></script>
41
-```
42
-
43
-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.
44
-
45
-If you'd like to use [bower](http://bower.io), it's as easy as:
36
+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.
37
47
-```sh
48
-bower install --save react
49
-```
50
-
51
-And it's just as easy with [npm](http://npmjs.com):
38
+The recommended way to install React depends on your project. Here you can find short guides for the most common scenarios:
39
53
-```sh
54
-npm i --save react
55
-```
40
+* [Trying Out React](https://facebook.github.io/react/docs/installation.html#trying-out-react)
41
+* [Creating a Single Page Application](https://facebook.github.io/react/docs/installation.html#creating-a-single-page-application)
42
+* [Adding React to an Existing Application](https://facebook.github.io/react/docs/installation.html#adding-react-to-an-existing-application)
43
44
## Contributing
45
grunt/config/compress.js
deleted
-16
@@ -1,16 +0,0 @@
1
-'use strict';
2
-
3
-var grunt = require('grunt');
4
-
5
-var version = grunt.config.data.pkg.version;
6
-
7
-module.exports = {
8
- starter: {
9
- options: {
10
- archive: './build/react-' + version + '.zip',
11
- },
12
- files: [
13
- {cwd: './build/starter', src: ['**'], dot: true, dest: 'react-' + version + '/'},
14
- ],
15
- },
16
-};
grunt/tasks/release.js
-39
@@ -15,17 +15,6 @@ var BOWER_FILES = [
15
'react-dom-server.min.js',
16
];
17
18
-var EXAMPLES_PATH = 'examples/';
19
-var EXAMPLES_GLOB = [EXAMPLES_PATH + '**/*.*', EXAMPLES_PATH + '**/.babelrc'];
20
-
21
-var STARTER_PATH = 'starter/';
22
-var STARTER_GLOB = [STARTER_PATH + '/**/*.*'];
23
-
24
-var STARTER_BUILD_PATH = 'build/starter/';
25
-
26
-var JS_PATH = 'build/';
27
-var JS_GLOB = [JS_PATH + '/*.js'];
28
-
18
var VERSION;
19
var VERSION_STRING;
20
@@ -98,7 +87,6 @@ function bower() {
87
}
88
89
function docs() {
101
- grunt.file.copy('build/react-' + VERSION + '.zip', 'docs/downloads/react-' + VERSION + '.zip');
90
grunt.file.copy('build/react.js', 'docs/js/react.js');
91
grunt.file.copy('build/react-dom.js', 'docs/js/react-dom.js');
92
}
@@ -108,7 +96,6 @@ function msg() {
96
grunt.log.subhead('Release *almost* complete...');
97
var steps = [
98
'Still todo:',
111
- '* add starter pack (`git add -f docs/downloads/react-version.zip`) and commit',
99
'* push this repo with tags',
100
'* push bower repo with tags',
101
'* run `npm-publish` in rrm',
@@ -121,36 +108,10 @@ function msg() {
108
});
109
}
110
124
-function starter() {
125
- // Copy over examples/ to build/starter/examples/
126
- // and starter/ to build/starter/
127
-
128
- grunt.file.expand(EXAMPLES_GLOB).forEach(function(file) {
129
- grunt.file.copy(
130
- file,
131
- STARTER_BUILD_PATH + file
132
- );
133
- });
134
-
135
- grunt.file.expand(STARTER_GLOB).forEach(function(file) {
136
- grunt.file.copy(
137
- file,
138
- 'build/' + file
139
- );
140
- });
141
-
142
- grunt.file.expand(JS_GLOB).forEach(function(file) {
143
- grunt.file.copy(
144
- file,
145
- STARTER_BUILD_PATH + file
146
- );
147
- });
148
-}
111
112
module.exports = {
113
setup: setup,
114
bower: bower,
115
docs: docs,
116
msg: msg,
155
- starter: starter,
117
};
package.json
-1
@@ -55,7 +55,6 @@
55
"grunt-cli": "^0.1.13",
56
"grunt-compare-size": "^0.4.0",
57
"grunt-contrib-clean": "^0.6.0",
58
- "grunt-contrib-compress": "^0.14.0",
58
"gulp": "^3.9.0",
59
"gulp-babel": "^6.0.0",
60
"gulp-flatten": "^0.2.0",
starter/README.md
deleted
-11
@@ -1,11 +0,0 @@
1
-# Welcome to React!
2
-
3
-You've just downloaded the React starter kit... Congratulations!
4
-
5
-To begin, check out the `examples/` directory for a bunch of examples, or check out [Getting Started](https://facebook.github.io/react/docs/getting-started.html) for more information.
6
-
7
-In some browsers our examples won't work from the local file system; run `python -m SimpleHTTPServer` and visit `http://localhost:8000/` to view them.
8
-
9
-Want to start your own app? Just copy `examples/basic-jsx-external` and start hacking! Remember: before launching you'll want to precompile your JSX code as we do in `examples/basic-jsx-precompile`; this requires doing `npm install -g react-tools` and then running our `jsx` tool. See [Getting Started](https://facebook.github.io/react/docs/getting-started.html) for more information.
10
-
11
-Happy Hacking!
yarn.lock
+7
-89
@@ -115,19 +115,6 @@ aproba@^1.0.3:
115
version "1.0.4"
116
resolved "https://registry.yarnpkg.com/aproba/-/aproba-1.0.4.tgz#2713680775e7614c8ba186c065d4e2e52d1072c0"
117
118
-archiver@^0.16.0:
119
- version "0.16.0"
120
- resolved "https://registry.yarnpkg.com/archiver/-/archiver-0.16.0.tgz#bb570346899d0865eb77ed66727ab3c634fc1a50"
121
- dependencies:
122
- async "~1.4.2"
123
- buffer-crc32 "~0.2.1"
124
- glob "~5.0.0"
125
- lazystream "~0.1.0"
126
- lodash "~3.10.0"
127
- readable-stream "~1.0.26"
128
- tar-stream "~1.2.1"
129
- zip-stream "~0.6.0"
130
-
118
archy@^1.0.0:
119
version "1.0.0"
120
resolved "https://registry.yarnpkg.com/archy/-/archy-1.0.0.tgz#f9c8c13757cc1dd7bc379ac77b2c62a5c2868c40"
@@ -268,10 +255,6 @@ async@~0.2.6:
255
version "0.2.10"
256
resolved "https://registry.yarnpkg.com/async/-/async-0.2.10.tgz#b6bbe0b0674b9d719708ca38de8c237cb526c3d1"
257
271
-async@~1.4.2:
272
- version "1.4.2"
273
- resolved "https://registry.yarnpkg.com/async/-/async-1.4.2.tgz#6c9edcb11ced4f0dd2f2d40db0d49a109c088aab"
274
-
258
asynckit@^0.4.0:
259
version "0.4.0"
260
resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79"
@@ -912,7 +895,7 @@ binary-extensions@^1.0.0:
895
version "1.7.0"
896
resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-1.7.0.tgz#6c1610db163abfb34edfe42fa423343a1e01185d"
897
915
-bl@^1.0.0, bl@~1.1.2:
898
+bl@~1.1.2:
899
version "1.1.2"
900
resolved "https://registry.yarnpkg.com/bl/-/bl-1.1.2.tgz#fdca871a99713aa00d19e3bbba41c44787a65398"
901
dependencies:
@@ -1112,10 +1095,6 @@ bser@^1.0.2:
1095
dependencies:
1096
node-int64 "^0.4.0"
1097
1115
-buffer-crc32@~0.2.1:
1116
- version "0.2.6"
1117
- resolved "https://registry.yarnpkg.com/buffer-crc32/-/buffer-crc32-0.2.6.tgz#612b318074fc6c4c30504b297247a1f91641253b"
1118
-
1098
buffer-shims@^1.0.0:
1099
version "1.0.0"
1100
resolved "https://registry.yarnpkg.com/buffer-shims/-/buffer-shims-1.0.0.tgz#9978ce317388c649ad8793028c3477ef044a8b51"
@@ -1364,15 +1343,6 @@ commoner@~0.10.3:
1343
q "^1.1.2"
1344
recast "^0.10.0"
1345
1367
-compress-commons@~0.3.0:
1368
- version "0.3.0"
1369
- resolved "https://registry.yarnpkg.com/compress-commons/-/compress-commons-0.3.0.tgz#97093e2e193f7567fa13203d4b8defcd5971a519"
1370
- dependencies:
1371
- buffer-crc32 "~0.2.1"
1372
- crc32-stream "~0.3.1"
1373
- node-int64 "~0.4.0"
1374
- readable-stream "~1.0.26"
1375
-
1346
concat-map@0.0.1:
1347
version "0.0.1"
1348
resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
@@ -1433,13 +1403,6 @@ coveralls@^2.11.6:
1403
minimist "1.2.0"
1404
request "2.75.0"
1405
1436
-crc32-stream@~0.3.1:
1437
- version "0.3.4"
1438
- resolved "https://registry.yarnpkg.com/crc32-stream/-/crc32-stream-0.3.4.tgz#73bc25b45fac1db6632231a7bfce8927e9f06552"
1439
- dependencies:
1440
- buffer-crc32 "~0.2.1"
1441
- readable-stream "~1.0.24"
1442
-
1406
"crc32@>= 0.2.2":
1407
version "0.2.2"
1408
resolved "https://registry.yarnpkg.com/crc32/-/crc32-0.2.2.tgz#7ad220d6ffdcd119f9fc127a7772cacea390a4ba"
@@ -1731,12 +1694,6 @@ encoding@^0.1.11:
1694
dependencies:
1695
iconv-lite "~0.4.13"
1696
1734
-end-of-stream@^1.0.0:
1735
- version "1.1.0"
1736
- resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.1.0.tgz#e9353258baa9108965efc41cb0ef8ade2f3cfb07"
1737
- dependencies:
1738
- once "~1.3.0"
1739
-
1697
end-of-stream@~0.1.5:
1698
version "0.1.5"
1699
resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-0.1.5.tgz#8e177206c3c80837d85632e8b9359dfe8b2f6eaf"
@@ -2358,7 +2315,7 @@ glob2base@^0.0.12:
2315
dependencies:
2316
find-index "^0.1.1"
2317
2361
-glob@5.x, glob@^5.0.15, glob@^5.0.5, glob@~5.0.0:
2318
+glob@5.x, glob@^5.0.15, glob@^5.0.5:
2319
version "5.0.15"
2320
resolved "https://registry.yarnpkg.com/glob/-/glob-5.0.15.tgz#1bc936b9e02f4a603fcc222ecf7633d30b8b93b1"
2321
dependencies:
@@ -2504,14 +2461,6 @@ grunt-contrib-clean@^0.6.0:
2461
dependencies:
2462
rimraf "~2.2.1"
2463
2507
-grunt-contrib-compress@^0.14.0:
2508
- version "0.14.0"
2509
- resolved "https://registry.yarnpkg.com/grunt-contrib-compress/-/grunt-contrib-compress-0.14.0.tgz#556dae0bed3d8ccd7b4cfcbcc6bbdacdffb2be77"
2510
- dependencies:
2511
- archiver "^0.16.0"
2512
- chalk "^1.0.0"
2513
- pretty-bytes "^2.0.1"
2514
-
2464
grunt-legacy-log-utils@~0.1.1:
2465
version "0.1.1"
2466
resolved "https://registry.yarnpkg.com/grunt-legacy-log-utils/-/grunt-legacy-log-utils-0.1.1.tgz#c0706b9dd9064e116f36f23fe4e6b048672c0f7e"
@@ -3436,12 +3385,6 @@ lazy-cache@^1.0.3:
3385
version "1.0.4"
3386
resolved "https://registry.yarnpkg.com/lazy-cache/-/lazy-cache-1.0.4.tgz#a1d78fc3a50474cb80845d3b3b6e1da49a446e8e"
3387
3439
-lazystream@~0.1.0:
3440
- version "0.1.0"
3441
- resolved "https://registry.yarnpkg.com/lazystream/-/lazystream-0.1.0.tgz#1b25d63c772a4c20f0a5ed0a9d77f484b6e16920"
3442
- dependencies:
3443
- readable-stream "~1.0.2"
3444
-
3388
lcid@^1.0.0:
3389
version "1.0.0"
3390
resolved "https://registry.yarnpkg.com/lcid/-/lcid-1.0.0.tgz#308accafa0bc483a3867b4b6f2b9506251d1b835"
@@ -3653,7 +3596,7 @@ lodash.templatesettings@^3.0.0:
3596
lodash._reinterpolate "^3.0.0"
3597
lodash.escape "^3.0.0"
3598
3656
-lodash@^3.10.0, lodash@^3.2.0, lodash@^3.9.3, lodash@~3.10.0, lodash@~3.10.1:
3599
+lodash@^3.10.0, lodash@^3.2.0, lodash@^3.9.3:
3600
version "3.10.1"
3601
resolved "https://registry.yarnpkg.com/lodash/-/lodash-3.10.1.tgz#5bf45e8e49ba4189e17d482789dfd15bd140b7b6"
3602
@@ -3733,7 +3676,7 @@ marked@^0.3.6:
3676
version "0.3.6"
3677
resolved "https://registry.yarnpkg.com/marked/-/marked-0.3.6.tgz#b2c6c618fccece4ef86c4fc6cb8a7cbf5aeda8d7"
3678
3736
-meow@^3.1.0, meow@^3.3.0:
3679
+meow@^3.3.0:
3680
version "3.7.0"
3681
resolved "https://registry.yarnpkg.com/meow/-/meow-3.7.0.tgz#72cb668b425228290abbfa856892587308a801fb"
3682
dependencies:
@@ -3909,7 +3852,7 @@ node-fetch@^1.0.1:
3852
encoding "^0.1.11"
3853
is-stream "^1.0.1"
3854
3912
-node-int64@^0.4.0, node-int64@~0.4.0:
3855
+node-int64@^0.4.0:
3856
version "0.4.0"
3857
resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b"
3858
@@ -4222,14 +4165,6 @@ preserve@^0.2.0:
4165
version "0.2.0"
4166
resolved "https://registry.yarnpkg.com/preserve/-/preserve-0.2.0.tgz#815ed1f6ebc65926f865b310c0713bcb3315ce4b"
4167
4225
-pretty-bytes@^2.0.1:
4226
- version "2.0.1"
4227
- resolved "https://registry.yarnpkg.com/pretty-bytes/-/pretty-bytes-2.0.1.tgz#155ec4d0036f41391e7045d6dbe4963d525d264f"
4228
- dependencies:
4229
- get-stdin "^4.0.1"
4230
- meow "^3.1.0"
4231
- number-is-nan "^1.0.0"
4232
-
4168
pretty-format@^18.0.0:
4169
version "18.0.0"
4170
resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-18.0.0.tgz#5f45c59fe2ed6749d46765429679670b08b21137"
@@ -4345,7 +4280,7 @@ read-pkg@^1.0.0:
4280
normalize-package-data "^2.3.2"
4281
path-type "^1.0.0"
4282
4348
-"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:
4283
+"readable-stream@>=1.0.33-1 <1.1.0-0":
4284
version "1.0.34"
4285
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.0.34.tgz#125820e34bc842d2f2aaafafe4c2916ee32c157c"
4286
dependencies:
@@ -4363,7 +4298,7 @@ read-pkg@^1.0.0:
4298
isarray "0.0.1"
4299
string_decoder "~0.10.x"
4300
4366
-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:
4301
+"readable-stream@^2.0.0 || ^1.1.13", readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.1.0:
4302
version "2.2.2"
4303
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.2.2.tgz#a9e6fec3c7dda85f8bb1b3ba7028604556fc825e"
4304
dependencies:
@@ -4955,15 +4890,6 @@ tar-pack@~3.3.0:
4890
tar "~2.2.1"
4891
uid-number "~0.0.6"
4892
4958
-tar-stream@~1.2.1:
4959
- version "1.2.2"
4960
- resolved "https://registry.yarnpkg.com/tar-stream/-/tar-stream-1.2.2.tgz#9632f23d98fd33d41661bbdec05489120dec6028"
4961
- dependencies:
4962
- bl "^1.0.0"
4963
- end-of-stream "^1.0.0"
4964
- readable-stream "^2.0.0"
4965
- xtend "^4.0.0"
4966
-
4893
tar@~2.2.1:
4894
version "2.2.1"
4895
resolved "https://registry.yarnpkg.com/tar/-/tar-2.2.1.tgz#8e4d2a256c0e2185c6b18ad694aec968b83cb1d1"
@@ -5420,11 +5346,3 @@ yargs@~3.27.0:
5346
os-locale "^1.4.0"
5347
window-size "^0.1.2"
5348
y18n "^3.2.0"
5423
-
5424
-zip-stream@~0.6.0:
5425
- version "0.6.0"
5426
- resolved "https://registry.yarnpkg.com/zip-stream/-/zip-stream-0.6.0.tgz#ee933aed996fb18b344a91ae3b5d264cec5e812b"
5427
- dependencies:
5428
- compress-commons "~0.3.0"
5429
- lodash "~3.10.1"
5430
- readable-stream "~1.0.26"