├── LICENSE.md └── README.md /LICENSE.md: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2016 Dan G Nelson 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # React Native Version Support Table 2 | A standardized table to be added to the beginning of React Native component README files which shows the version number and which version of React Native, iOS, & Android it was successfully last tested on by the developer. 3 | 4 | ## Example 5 | 6 | | Version | React Native Support | Android Support | iOS Support | 7 | |---|---|---|---| 8 | | 0.0.1 | 0.34.1 | 7.1 | 10.0.2 | 9 | 10 | *Complies with [react-native-version-support-table](https://github.com/dangnelson/react-native-version-support-table)* 11 | 12 | ## What this solves 13 | Help solves the problem many developers face when starting new React Native projects with multiple components where build and or usage errors occur. Makes troubleshooting / choosing versions a more transparent process. 14 | 15 | Saves component developers the headache of additional repository issues being created because new versions aren't yet supported. 16 | 17 | ## Usage 18 | 19 | ### Placement 20 | 21 | Add after your first H1 title header. This allows for developers to see whether or not your component is compatiable with their app before diving into your documentation. 22 | 23 | ### Markdown 24 | Copy this Markdown and add it to the beginning of your README file before the first header. Change the version numbers to the latest you've tested your component on. 25 | ``` 26 | | Version | React Native Support | Android Support | iOS Support | 27 | |---|---|---|---| 28 | | 0.0.1 | 0.34.1 | 7.1 | 10.0.2 | 29 | 30 | *Complies with [react-native-version-support-table](https://github.com/dangnelson/react-native-version-support-table)* 31 | ``` 32 | 33 | ### iOS / Android Only 34 | Use "NONE" in place of version number. 35 | 36 | Example: 37 | 38 | | Version | React Native Support | Android Support | iOS Support | 39 | |---|---|---|---| 40 | | 0.0.1 | 0.34.1 | NONE | 10.0.2 | 41 | 42 | *Complies with [react-native-version-support-table](https://github.com/dangnelson/react-native-version-support-table)* 43 | 44 | ### Multiple Versions 45 | Add multiple rows (sort from newest to oldest) to show component versions successfully tested across additional Operating System or React Native versions. This should be used when there's a breaking change that doesn't allow the latest version of your component to support older verisons of React Native or Android / iOS. Links to seperate README files are recommended if documentation has changed between versions. 46 | 47 | Example: 48 | 49 | | Version | React Native Support | Android Support | iOS Support | Documentation | 50 | |---|---|---|---|---| 51 | | 1.0.0 | 0.34.1 | 7.1 | 10.0.2 | [README]() | 52 | | 0.9.2 | 0.33.0 | 7.1 | 10.0.2 | [README]() | 53 | 54 | *Complies with [react-native-version-support-table](https://github.com/dangnelson/react-native-version-support-table)* 55 | 56 | ### Version Ranges 57 | 58 | For a range of versions use a dash ( **-** ). 59 | 60 | Don't use less than or equal to ( **<=** ) or greater than or equal to ( **>=** ) symbols as they suggests there's support for past/future versions the component may not actually work with. 61 | 62 | Example: 63 | 64 | | Version | React Native Support | Android Support | iOS Support | Documentation | 65 | |---|---|---|---|---| 66 | | 1.0.8 | 0.28 - 0.32 | 7.0 - 7.1 | 10.0.0 - 10.0.2 | [README]() | 67 | | 1.0.1 - 1.0.7 | 0.27 | 5.0 - 6.0.1 | 7.2 - 9.3.5 | [README]() | 68 | 69 | *Complies with [react-native-version-support-table](https://github.com/dangnelson/react-native-version-support-table)* 70 | 71 | 72 | ## Components Currently Supporting This Standard 73 | 74 | * [react-native-permissions](https://github.com/yonahforst/react-native-permissions) 75 | * [tcomb-form-native](https://github.com/gcanti/tcomb-form-native) 76 | 77 | Please add a New Issue if there's a component you know of using this standard that's not on the list. 78 | --------------------------------------------------------------------------------