rn-boiler-template - npm Package Compare versions

Comparing version 1.0.5 to 1.62.2

package.json

 {
   "name": "rn-boiler-template",
-  "version": "1.0.5",
+  "version": "1.62.2",
   "description": "Clean and minimalist React Native template for a quick start with TypeScript and components",
@@ -5,0 +5,0 @@ "scripts": {

README.md

 ## Welcome to the Boilerplate React Native
 
-> How to build
+:fireworks: Clean and minimalist React Native template for a quick start with TypeScript and so much more components.
 
-- Install react native
-  https://reactnative.dev/docs/getting-started
-- Create new project
-  `npx react-native init <yourProjectName> --template react-native-template-typescript`
-- Copy all file to your project without `package.json` and `preview.gif` files
-- Modify your `package.json` :
-    + Replace your `script` tag by my `script` tag
-    + Append my `dependencies` tag to your `dependencies` tag 
-    + Replace your `devDependencies` by my `devDependencies` tag
-- Install package
-  `npm install` or
-  `yarn` or `yarn yarn-ios`(ios) (recommended)
-- Run your app
-  `npx react-native run-android/ios` or `yarn android/ios `or `npm run android/ios`
-- <h2>Notes</h2>
-+ This boilerplate uses libraries [react native reanimated](https://docs.swmansion.com/react-native-reanimated/docs) and [react-native-gesture-handle](https://github.com/software-mansion/react-native-gesture-handler). Please follow their installation instructions.
-- <h3>Preview</h3>
-<img src="./preview.gif">
+## :star: Features
+
+- Elegant usage directly within the RN-Boiler Cli
+- Consistent with the default React Native template
+- Minimal additional dependencies
+- Lots of built-in components
+
+## :arrow_forward: Usage
+
+```sh
+npx rn-boiler MyApp
+```
+
+### Usage with older versions of React Native
+
+#### e.g. `react-native@0.62.x`
+
+```sh
+npx rn-boiler MyApp --version 1.62.*
+```
+
+See the below table to find out which version of the template to use.
+
+#### React Native <=> Template Version
+
+| React Native   | Template   |
+|---             |---         |
+| 0.63           | 1.63.*       |
+| 0.62           | 1.62.*       |
+<h3>Preview</h3>
+<img src="./preview.gif">
+
+## :bookmark: License
+
+This project is [MIT](LICENSE) licensed.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

40

increased by81.82%

Worsened metrics

Total package byte prevSize

3970956

No dependency changes