From d339756b9186428c1f7e3d1e1200f492b7ca4d64 Mon Sep 17 00:00:00 2001 From: Tom McIntosh <46665295+tj-mc@users.noreply.github.com> Date: Fri, 13 Nov 2020 14:08:04 +1000 Subject: [PATCH] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c853d98..90c4324 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,12 @@ ios/{projectName}.xcodeproj/project.pbxproj MARKETING_VERSION package.json "version" ``` -##🌐 Install +## 🌐 Install npm: ```npm i react-native-version-setter``` yarn: ```yarn add react-native-version-setter``` -##πŸš€ Usage +## πŸš€ Usage Simply call `npm run setVersion` or `yarn run setVersion` in your project root. ``` @@ -32,7 +32,7 @@ $: npm run setVersion 1.2.0 [RNVS] Version is already 1.2.0 πŸ›‘ ``` -##πŸ‘©β€πŸ’» Freeform Versioning +## πŸ‘©β€πŸ’» Freeform Versioning RNVS does not impose restrictions on versioning style. Feel free set your version numbers in whatever format works for you. For example, Date-based versioning: ``` @@ -45,19 +45,19 @@ In most cases it makes sense to use conventional [semantic versioning.](https:// From version 2, RNVS has full support for extended semVer syntax, like `1.2.3-alpha`. These symbols are not supported on iOS, so they are stripped out automatically. They will be inserted normal into android files and `package.json`. -##β›³ Flags +## β›³ Flags `-d`: Runs with debug logging. `-r`: Prepares version strings, but logs to console instead of writing to file. -##πŸ’» Compatibility +## πŸ’» Compatibility - Compatible with iOS projects using Xcode 11+ -##πŸ—ΊοΈ Roadmap +## πŸ—ΊοΈ Roadmap - getVersion command - setVersion per-platform -##πŸ‘‹ Troubleshooting +## πŸ‘‹ Troubleshooting #### Version setting not working on new project Ensure you have opened the generated `.xcodeproj` file at least once. On the first opening, Xcode will create the `MARKETING_VERSION` field that holds your app version. Prioed to this, there is nowhere to store the iOS version.