Skip to content

Commit c007d03

Browse files
authored
Merge pull request #33 from OneSignal/improvement/update-readme
Update README.md
2 parents 736ae5e + dabb800 commit c007d03

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44

55
The OneSignal CLI is a tool to work with OneSignal projects.
66

7-
# Setup
8-
1. Clone the repository
9-
2. If you do not have bundler 2 installed run `gem install bundler`
10-
3. Run `bin/bundle install` from the root directory of the repository
11-
4. Commands can be run via `bin/onesignal <command>` from the root of the repository
7+
# Mac Setup
8+
1. Have Homebrew installed
9+
2. Run `brew tap OneSignal/cli https://github.com/OneSignal/cli`
10+
3. Run `brew install onesignal-cli`
11+
4. Run `/usr/local/Cellar/onesignal-cli/{CLI_Version_Number}/bin/bundle install` Example: `/usr/local/Cellar/onesignal-cli/0.0.3/bin/bundle install`
1212

1313
## Available commands
1414

15-
* `bin/onesignal help` Lists the available commands in the OneSignal CLI
16-
* `bin/onesignal install-sdk` Install the OneSignal SDK in the project
15+
* `onesignal help` Lists the available commands in the OneSignal CLI
16+
* `onesignal install-sdk` Install the OneSignal SDK in the project
1717

1818
## Installation Command
1919
This command can be used to add the OneSignal SDK to your mobile application project.
@@ -38,14 +38,13 @@ Options:
3838
* target - name of the App target to install in. Defaults to the entrypoint name. iOS only.
3939

4040
Arguments:
41-
* Path - path to the project directory
4241
* Entrypoint - Name of the target XCProject (iOS) or Application class file directory (Android). For Android, if no application class is available, the CLI will create it in the directory and name file provided. For the CLI to create the file for you, you will need to provide the directory inside the project and file name with the extension where you want the Application file to be created. Example: app/src/main/java/com/onesignal/testapplication/BaseApp.java
4342
* LANG - programming language to use for ios (objc, swift) or Android (java, kotlin)
4443
* APPID - Optional. OneSignal App ID. Not yet used for iOS installs.
4544

46-
Example Usage
47-
* iOS: `bin/onesignal install-sdk --type ios ../MyAppDir MyApp objc`
48-
* Android: `bin/onesignal install-sdk --type android ../MyAppDir app/src/main/java/com/onesignal/testapplication/BaseApp.java java <APPID>`
45+
Example Usage, run the following command on the root project directory where OneSignal SDK is going to be use
46+
* iOS: `onesignal install-sdk --type iOS --entrypoint MyApp --lang objc --appid <APPID>`
47+
* Android: `onesignal install-sdk --type android --entrypoint app/src/main/java/com/onesignal/testapplication/BaseApp.kt --appid <APPID>`
4948

5049
## Limitations / Comming Soon
5150
* React Native, Flutter, Unity, Xamarin, and Cordova aren't currently supported. Stay tuned for support in a future release!

0 commit comments

Comments
 (0)