Commit Graph

84 Commits

Author SHA1 Message Date
tiagomoraismorgado c544c0d2dc Docs - README.md - tweaks (separator, thumbnail logo)
Summary:
**this PR does basically aim at adding the following tweaks to README.md file:**
- *separators*
- *thumbnail logo*

 ---

**main motivation behind such:**
- *improving overall document accessebility*

 ---

<img src="https://avatars2.githubusercontent.com/u/69631?s=200&v=4" width="50"></img> <img src="https://avatars1.githubusercontent.com/u/7303598?s=460&v=4" width="50"></img>
Closes https://github.com/facebook/react-native/pull/16509

Differential Revision: D6465270

Pulled By: hramos

fbshipit-source-id: 0443765bdc0001926157ad0443a035be6992c418
2017-12-01 16:59:07 -08:00
ryanml 6da897945f Fixing bad link to RN documentation.
Summary:
The link referencing the root of RN documentation was leading to a 404 error. As the docs don't seem to have a true "index" page, it makes sense that it goes to the top level entry in the docs, the "Getting Started Section". The alternative solution may be not linking that phrase at all, this seems helpful though.

No changes in this pull request require any sort of unit/AB testing, the link directing to the correct place should be apparent.

[DOCS] [BUGFIX] [README.md] - Fixing doc resource link.
Closes https://github.com/facebook/react-native/pull/17048

Differential Revision: D6464455

Pulled By: hramos

fbshipit-source-id: 710dc882672d762478910538341b57cb1bb129bb
2017-12-01 16:17:52 -08:00
Maximiliano Castro 724e6eafac Docs - README.md - Fix Good First Issue Link
Summary:
<!--
Thank you for sending the PR! We appreciate you spending the time to work on these changes.

Help us understand your motivation by explaining why you decided to make this change.

You can learn more about contributing to React Native here: http://facebook.github.io/react-native/docs/contributing.html

Happy contributing!

-->

I was reading the README and I noticed the link to [Good first issue](https://github.com/facebook/react-native/labels/Good%20first%20issue) was pointing to a wrong label.

N/A

[DOCS][BUGFIX][README.md] - Fix beginners friendly bug link in README.md

<!--
Help reviewers and the release process by writing your own release notes

**INTERNAL and MINOR tagged notes will not be included in the next version's final release notes.**

  CATEGORY
[----------]        TYPE
[ CLI      ]   [-------------]      LOCATION
[ DOCS     ]   [ BREAKING    ]   [-------------]
[ GENERAl  ]   [ BUGFIX      ]   [-{Component}-]
[ INTERNAL ]   [ ENHANCEMENT ]   [ {File}      ]
[ IOS      ]   [ FEATURE     ]   [ {Directory} ]   |-----------|
[ ANDROID  ]   [ MINOR       ]   [ {Framework} ] - | {Message} |
[----------]   [-------------]   [-------------]   |-----------|

[CATEGORY] [TYPE] [LOCATION] - MESSAGE

 EXAMPLES:

 [IOS] [BREAKING] [FlatList] - Change a thing that breaks other things
 [ANDROID] [BUGFIX] [TextInput] - Did a thing to TextInput
 [CLI] [FEATURE] [local-cli/info/info.js] - CLI easier to do things with
 [DOCS] [BUGFIX] [GettingStarted.md] - Accidentally a thing/word
 [GENERAL] [ENHANCEMENT] [Yoga] - Added new yoga thing/position
 [INTERNAL] [FEATURE] [./scripts] - Added thing to script that nobody will see
-->
Closes https://github.com/facebook/react-native/pull/16523

Differential Revision: D6138904

Pulled By: hramos

fbshipit-source-id: 42800feca9445156eac7d479ee8548c4a427f156
2017-10-24 15:31:56 -07:00
Héctor Ramos 400f5b7bc9 s/React/React Native
Summary:
This should have said React Native.
Closes https://github.com/facebook/react-native/pull/16418

Differential Revision: D6080529

Pulled By: hramos

fbshipit-source-id: df184c48daa71a3fa2045d2a7a75b86e3c2e6f09
2017-10-17 13:18:07 -07:00
Héctor Ramos 0266b70379 Remove references to Travis
Summary:
Removing remaining references to Travis, which is removed in #16354.

Test Plan

None
Closes https://github.com/facebook/react-native/pull/16364

Differential Revision: D6057590

Pulled By: hramos

fbshipit-source-id: 574a5cbbddbc09b48307d70555901b6ab5940e40
2017-10-13 20:34:22 -07:00
jxsh 9cf2b11f49 Changed React to React Native in README.md
Summary:
<!--
Thank you for sending the PR! We appreciate you spending the time to work on these changes.

Help us understand your motivation by explaining why you decided to make this change.

You can learn more about contributing to React Native here: http://facebook.github.io/react-native/docs/contributing.html

Happy contributing!

-->

Referencing #16142
Closes https://github.com/facebook/react-native/pull/16146

Differential Revision: D5950544

Pulled By: TheSavior

fbshipit-source-id: 6a679ed2ca1fdb91a4240f02e68bbef858b5b645
2017-09-30 14:32:28 -07:00
Hitabis GmbH 2757260624 README: Remove broken link to section
Summary:
Section `#opening-issues` was removed in commit d1c9746902
Closes https://github.com/facebook/react-native/pull/15739

Differential Revision: D5767518

Pulled By: hramos

fbshipit-source-id: 9485470aae88e9aeff4e20f3c8d454244ccd8f50
2017-09-05 10:53:17 -07:00
Hector Ramos b6454e948f How to Contribute updates
Summary:
Rename "Testing" guide. Add docs for several new GitHub bot commands. Format commands table.

Built website and verified everything looks good.
Closes https://github.com/facebook/react-native/pull/15111

Differential Revision: D5458660

Pulled By: hramos

fbshipit-source-id: 151ea0cbd18489bc527193682464ca291d6ab467
2017-07-19 17:47:01 -07:00
Hector Ramos d1c9746902 Move CONTRIBUTING guidelines to a standalone doc in the website.
Reviewed By: TheSavior

Differential Revision: D5448961

fbshipit-source-id: c8491b003413e8af22987ea578d6f7bbe1552b31
2017-07-19 10:23:06 -07:00
Hyunchel Kim b302bec531 Replace Navigator references to with existing components
Summary:
Navigator page("docs/navigator.html") does not exist anymore b/c the
Navigator component itself has been removed from the package.

Replace Navigator references to other components that are less likely
to be changed over time(e.g. TextInput and Button components).

No plans to test as this change is on README of the repository.

No issue was created b/c this is not a bug on code nor a feature
request. And there already is an awareness of dead Navigation links
floating inside this repository(e.g. #13804).

Thanks for submitting a PR! Please read these instructions carefully:

- [x] Explain the **motivation** for making this change.
- [x] Provide a **test plan** demonstrating that the code is solid.
- [x] Match the **code formatting** of the rest of the codebase.
- [x] Target the `master` branch, NOT a "stable" branch.

[1]: https://medium.com/martinkonicek/what-is-a-test-plan-8bfc840ec171#.y9lcuqqi9
[2]: https://code.facebook.com/cla
[3]: https://travis-ci.org/facebook/react-native
[4]: http://circleci.com/gh/facebook/react-native
[5]: https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#pull-requests
Closes https://github.com/facebook/react-native/pull/13848

Differential Revision: D5148506

Pulled By: shergin

fbshipit-source-id: e4ecabf05e58efdbe3aca2c4b86e7d884ff6ed62
2017-05-30 12:01:38 -07:00
Brent Vatne 514d8fc22f Update the README Examples section for RNTester
Summary:
The Examples directory no longer exists and the instructions in this part of the README were stale.

Follow the instructions to run RNTester on iOS and Android

(this actually fails for me currently on Android, but I believe the instructions are correct and the failure is related to something else)

Closes #14222
Closes https://github.com/facebook/react-native/pull/14229

Differential Revision: D5144514

Pulled By: shergin

fbshipit-source-id: 19ca173e8c5e91de7e1e53a21dbcaa0968da092b
2017-05-28 00:17:23 -07:00
David Aurelio a710f9a81e Move packager launcher scripts outside of `packager/`
Summary: in order to prepare open sourcing React Native Packager, we have to move scripts specific to React Native to a directory that will continue to exist.

Reviewed By: javache

Differential Revision: D5112193

fbshipit-source-id: eac77d0d981aecef7ee52365a6856340420a5638
2017-05-23 16:17:09 -07:00
Eric Vicenti 4a80dceac7 Re-license and rename UIExplorer integration test app as RNTester
Reviewed By: yungsters

Differential Revision: D4950085

fbshipit-source-id: 44574b5d0ef0d2ad5dfc714309b18dc69cbad9ff
2017-05-08 11:31:19 -07:00
Andrew Rasmussen bf5aa9e1e7 Product Pains -> Canny
Summary:
We migrated everyone on Product Pains over to our new service, Canny. We also moved every product's feedback to a product-specific subdomain (eg. https://react-native.canny.io/feature-requests).

This PR updates every Product Pains URL over to its new Canny version.

Changes only affect docs, blog posts, and bot responses - not the React Native library itself.

**Test plan**

I visited https://react-native.canny.io/feature-requests. Since there are no code changes this seems sufficient but let me know if I need to run the blog website or something.
Closes https://github.com/facebook/react-native/pull/12429

Differential Revision: D4581492

Pulled By: hramos

fbshipit-source-id: 7d124ab7ed9228d47f1bc4417d8992f15ff17f01
2017-02-17 15:02:23 -08:00
Kevin Lacker 57f4671c8c remove no-longer-functional tutorial link
Summary:
As complained in issue https://github.com/facebook/react-native/issues/10209 there is a busted link in the readme.
Closes https://github.com/facebook/react-native/pull/12270

Differential Revision: D4526271

Pulled By: hramos

fbshipit-source-id: f493a550a60f338e357ab5717d5417088a18b1fd
2017-02-07 18:00:43 -08:00
Nicolas Charpentier 49729e9d2c Match CircleCI badge
Summary: Closes https://github.com/facebook/react-native/pull/12126

Differential Revision: D4486816

fbshipit-source-id: 2d06fe00438502ef70b12d11d18d2dd6b169a245
2017-01-30 19:13:36 -08:00
Pieter De Baets 07553d0f1c Update React Native minimum OS version to iOS8
Reviewed By: majak

Differential Revision: D3723143

fbshipit-source-id: 482f9820370b752d937e6df7f74c33d53a0a2e7d
2016-09-01 19:43:47 -07:00
Alec Winograd abe9f5188a Fix documentation link in README.md
Summary:
Updated link for `integrating with existing apps` documentation
Closes https://github.com/facebook/react-native/pull/8842

Differential Revision: D3576490

fbshipit-source-id: 20d7c39dec615a3928ddc98ef31c8fbcf063f145
2016-07-16 18:58:27 -07:00
q-- 599d76a64b Fix tutorial link in README.md
Summary:
The tutorial has moved to a different URL, so the link currently ends up at the getting started page.

I also changed the remaining non-HTTPS urls in README.md to use HTTPS after checking they supported it. And I changed the Addons.Mozilla.org link to a language-agnostic one.
Closes https://github.com/facebook/react-native/pull/8047

Differential Revision: D3430542

Pulled By: javache

fbshipit-source-id: 4c5ccea9a5720126870a5df1be5073a6cc2f34ae
2016-06-14 06:43:49 -07:00
Konstantin Raev 2957f734b4 removed bithound badge
Summary:see
Closes https://github.com/facebook/react-native/pull/6232

Differential Revision: D2994958

fb-gh-sync-id: 6dacce080dac48bc645c58ce5b87d96e0ec3ff04
shipit-source-id: 6dacce080dac48bc645c58ce5b87d96e0ec3ff04
2016-03-01 10:53:29 -08:00
Gord Tanner cf0c3d4342 Update wc to latest version to remove insecure warning
Summary:- [x] Updated wc dependency to latest version.
 - Noticed on bitHound wc was marked as insecure: [![bitHound Dependencies](https://www.bithound.io/github/facebook/react-native/badges/dependencies.svg)]
(https://www.bithound.io/github/facebook/react-native/master/dependencies/npm)
 - details on bitHound [here](https://www.bithound.io/github/facebook/react-native/master/dependencies/npm/ws)
 - Updated the dep to remove that warning: [![bitHound Dependencies](https://www.bithound.io/github/gtanner/react-native/badges/dependencies.svg)](https://www.bithound.io/github/gtanner/react-native/master/dependencies/npm)
  - bitHound generated pr can be seen [here](https://github.com/gtanner/react-native/pull/1)
- [x] Added a bitHound badge to the readme to track the state of your dependencies.

**Test plan**

* Ran `npm test` before and after updating the dependency
* Build the 2048 sample app and ensured that livereload / remote debugging / packaging was all still working since that is where I could see `ws
Closes https://github.com/facebook/react-native/pull/6153

Differential Revision: D2988876

fb-gh-sync-id: e19cce39d57214df082d42c59ac0d615496b0743
shipit-source-id: e19cce39d57214df082d42c59ac0d615496b0743
2016-02-29 07:10:35 -08:00
Michael Abt ed0e6a2250 Make link more specific
Directly link to the react-native part the site
2016-01-20 18:07:12 +01:00
Michael Abt 67e5fe662b Correct link to former react.rocks website
react.rocks has moved to js.coach and the packages at react.rocks aren't up to date anymore.
2016-01-20 16:00:08 +01:00
Qiao Liang d8e138770f added easy tasks to README 2016-01-03 14:48:07 +08:00
James Ide d52723efec [README] Add Circle CI status to the README 2015-12-16 14:24:22 -08:00
James Ide 5c9837a080 [README] Add Product Pains mentions to the README
GitHub +1's are low SnR and people resort to them because there's no voting mechanism - https://github.com/isaacs/github/issues/9 - but Product Pains addresses this and it's way better for seeing popular issues.
2015-11-17 15:25:50 -08:00
Alex Krolick 98c6017581 add link to upgrade instructions 2015-10-27 21:56:26 -07:00
James Ide 5227b10455 [README] Add clarification about GH issues being for bugs & feature requests 2015-10-21 11:26:50 -07:00
Jean de Klerk 2be0525b2a Small readme updates
- Link for firefox react dev tools
- Add missing word
2015-10-18 19:00:38 -06:00
Brent Vatne e59b28e6ca [README] Link to Reactiflux Discord invite 2015-10-18 11:58:59 -07:00
Christopher Chedeau 6bf58aa8aa Fix sync
Differential Revision: D2457857
2015-09-18 12:12:53 -07:00
James Ide 20e8b82b34 [README] Add link to react-native tag on Stack Overflow
Raise some awareness of the tag and let people know they can help by answering qquestions and be altruistic and helpful.
2015-09-16 15:00:45 -07:00
Christopher Chedeau aa768ddeb8 Bring back build status 2015-09-16 10:58:05 -07:00
Brent Vatne e2841c05b4 [README] Add note about supported operating systems 2015-09-16 09:51:41 -07:00
Martin Konicek f2f7da6ccd Update README.md 2015-09-15 20:58:06 +01:00
Martin Konicek 42eb5464fd Release React Native for Android
This is an early release and there are several things that are known
not to work if you're porting your iOS app to Android.

See the Known Issues guide on the website.

We will work with the community to reach platform parity with iOS.
2015-09-14 18:13:39 +01:00
Martin Konicek c51bfdc50c Update README.md 2015-09-14 13:56:39 +01:00
Christopher Chedeau 635b15b454 Testing new export script
Differential Revision: D2420548
2015-09-09 10:01:29 -07:00
James Ide 319fa06afb [README] Intro section that links to website 2015-09-06 17:22:14 -07:00
James Ide 7361f537c9 [README] Added a table of contents and some small rewording
The table of contents should make it easier to browse the README.
2015-09-06 16:45:35 -07:00
James Ide e5d4bfaf31 [README] New README co-authored with @brentvatne
This new README talks more about the react-native project, repository, and contribution process (the old one was more focused on technical details). @brentvatne and I want people to get help and file issues & PRs more effectively. Here's a first draft that we believe helps with that.
2015-09-06 16:30:29 -07:00
C. T. Lin 05b17a811e Add npm version badge 2015-08-15 11:42:33 +08:00
Nick Hudkins 7947f04b43 Update README.md to follow conventions
Don't submit pull requests from your phone while eating dinner or you will make careless mistakes.
2015-05-11 19:53:49 -04:00
Nick Hudkins d43d093bf7 Update README.md with valid code example.
Custom iOS View code sample was missing RCT_EXPORT_MODULE()
2015-05-11 19:06:15 -04:00
Spencer Ahrens 1fa55c23ce Update custom iOS component section to use requireNativeComponent 2015-04-20 19:37:01 -07:00
Nick Lockwood c3658fd90a Update README.md
Fixed missing param.
2015-04-19 21:58:43 +01:00
alanchen b03cb256e6 change to git clone https://github.com/facebook/react-native.git 2015-04-14 15:46:06 +08:00
Brent Vatne 127649962d Replace RCT_EXPORT with RCT_EXPORT_METHOD 2015-04-10 13:23:59 -07:00
Chris Jungmann 3ad16b96f1 Update README.md
Removed an extra bracket and line end "];" in the callback of the processString method.
2015-03-31 14:43:08 -06:00
Marin Usalj 015136f36e Fix Objective-C example in README 2015-03-30 14:45:49 -07:00