Adding documentation.

README.md

@@ -1,2 +1,160 @@
-# SiteWebr Buildnumbr App
+# BuildNumbr.com
 [![ci](https://github.com/yortyrh/buildnumbr-api/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/yortyrh/buildnumbr-api/actions/workflows/ci.yml)
+
+> Incrementing ios build numbers and android version codes as a service.
+
+```sh
+❯ curl -s https://buildnumbr.com/my-app
+1
+❯ curl -s https://buildnumbr.com/my-app
+2
+❯ curl -s https://buildnumbr.com/my-app
+3
+❯ curl -s https://buildnumbr.com/my-other-awesome-app
+1
+❯ curl -s https://buildnumbr.com/my-other-awesome-app/set/1267
+1267
+❯ curl -s https://buildnumbr.com/my-other-awesome-app
+1268
+# Get the current value without incrementing
+❯ curl -s https://buildnumbr.com/my-other-awesome-app/get
+1268
+```
+
+## Why?
+
+- Automatically incrementing the build number allows you to easily figure out what is the highest build number out there.
+- If you give every build that you make its own build number / version code, you can easily figure out which build caused trouble if problems arise.
+- As an iOS developer, you are required to increase the build number for each binary that you upload. If you forget it, the binary will be rejected, and you will have to compile and upload again.
+- As an Android developer, you are required to increase the version code for each app bundle that you upload. If you forget it, the binary will be rejected even if it belongs to a previous version.
+- You want to use continuous integration and don't want to commit build number / version code increases.
+- You need to have de-centralized builds where part of the team if allowed to build and deploy to google play / app store and at the same time make sure the version code / build number increases with every deploy.
+
+## Integrating with your project
+
+### IOS projects
+
+Move into the folder where your Info.plist is and execute this command:
+
+```sh
+/usr/libexec/PlistBuddy -c "Set :CFBundleVersion (curl https://buildnumbr.com/my-app)" Info.plist
+```
+
+### Android projects
+
+In your build.gradle, make the `versionCode` variable:
+`versionCode project.hasProperty('versionCode') ? project.property('versionCode') as int : 1`
+then pass the version code like this:
+
+```sh
+./gradlew assembleRelease -PversionCode=$(curl https://buildnumbr.com/my-app)
+```
+
+### Fastlane
+
+For iOS projects, use this step:
+
+```rb
+increment_build_number(
+  xcodeproj: './ios/MyAwesomeApp.xcodeproj',
+  build_number: sh('curl -s https://buildnumbr.com/my-app-ios')
+)
+```
+
+For Android projects, first change the `build.gradle` file as described above. Then specify the versionCode during your Gradle step:
+
+```rb
+gradle(task: 'assemble', build_type: 'Release', properties: {
+  versionCode: sh('curl -s https://buildnumbr.com/my-app-android')
+})
+```
+
+### Expo
+### Update app.json
+```javascript
+#!/usr/bin/env node
+const fs = require('fs');
+const execSync = require('child_process').execSync;
+const config = require('./app.json');
+
+const BUILD_NUMBER_COMPONENT_ID = 'my-app-ios';
+const VERSION_CODE_COMPONENT_ID = 'my-app-android';
+
+config.expo.ios.buildNumber=String(execSync(`curl -s https://buildnumbr.com/${BUILD_NUMBER_COMPONENT_ID}`));
+config.expo.android.versionCode=Number(execSync(`curl -s https://buildnumbr.com/${VERSION_CODE_COMPONENT_ID}`));
+
+fs.writeFileSync('app.json', JSON.stringify(config, null, 2));
+```
+### Use app.config.js
+```javascript
+const execSync = require('child_process').execSync;
+
+const BUILD_NUMBER_COMPONENT_ID = 'my-app-ios';
+const VERSION_CODE_COMPONENT_ID = 'my-app-android';
+
+module.exports = ({ config }) => {
+  const buildNumber=String(execSync(`curl -s https://buildnumbr.com/${BUILD_NUMBER_COMPONENT_ID}`));
+  const versionCode=Number(execSync(`curl -s https://buildnumbr.com/${VERSION_CODE_COMPONENT_ID}`));
+
+  return {
+    ...config,
+    ios: {
+      ...config.ios,
+      buildNumber,
+    },
+    android: {
+      ...config.android,
+      versionCode,
+    },
+  };
+};
+```
+
+## FAQ
+
+- **My cURL also prints the progress, not just the build number!** <br>
+  Try to add the -s flag to prevent progress being printed:
+
+```sh
+curl -s https://buildnumbr.com/my-app
+```
+
+- **There is no authentication! How do I prevent others from incrementing my build number?** <br>
+  Just use an identifier that is really hard to guess, like https://buildnumbr.com/01hmqaf00ft6c98h1ytdxh6286. Maybe not that one exactly, but you get the idea.
+
+- **How can I get a really hard to guess unique identifier?** <br>
+```sh
+npx ulid | sed -e 's/\(.*\)/\L\1/'
+```
+
+- **I incremented by accident. Can I go back?** <br>
+
+```sh
+# Get the current build number
+❯ curl -s https://buildnumbr.com/my-app/get
+456
+# Set the previous value (There isn't any service to decrease the value)
+❯ curl -s https://buildnumbr.com/my-app/set/455
+455
+```
+
+- **I want to make sure the build number you are providing is actually a number** <br>
+  You can add a check that the response that you get from buildnumbr.com is purely numeric.
+
+```sh
+export BUILD = $(curl https://buildnumbr.com/my-app)
+re='^[0-9]+$'
+    if ! [[ $BUILD =~ $re ]] ; then
+    echo "error: Not a number" >&2; exit 1
+fi
+```
+
+- **My current build number is already at 2498. How can I make buildnumbr.com start from this number?**<br>
+  There is another endpoint for this. Simply append `/set/{your_number}` and your counter will jump to this number.
+
+```sh
+curl https://buildnumbr.com/my-app/set/2498
+```
+
+## Credits
+This service is brought to you by [Yorty Ruiz Hernandez](https://linkedin.com/in/yorty)