Skip to content

Commit 3cde0f5

Browse files
committed
Add build status to README.md
1 parent 96f31ae commit 3cde0f5

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[![Build status](https://img.shields.io/github/workflow/status/pushbits/cli/Main)](https://github.com/pushbits/cli/actions)
12
![License](https://img.shields.io/github/license/pushbits/cli)
23

34
# PushBits CLI
@@ -26,11 +27,11 @@ Note that this requires [a working Go 1.12+ installation](https://golang.org/doc
2627

2728
## Usage
2829

29-
If you are a normal user of the PushBits server, you will most likely just want to manage your applications.
30+
If you are a normal user of PushBits, you will most likely just want to manage your applications.
3031
As an admin, you are possibly trying to manage your users.
3132
This tool provides help for both use cases.
3233

33-
In particular, the tool groups the different actions in two separate commands, `application` and `user`
34+
In particular, the tool supports two separate subcommands, `application` and `user`
3435
As the names suggest, the former lets you configure applications, while the latter deals with users.
3536

3637
To use this tool, you need to know the URL of your PushBits instance and the credentials (username and password) of your user.
@@ -83,10 +84,10 @@ Help Options:
8384

8485
So we need to provide a name for the application.
8586
Of course, we also need to provide the URL of the PushBits instance as well as the username.
86-
This means, to create an application with the name `Demo` for the user `myusername`, we need to run the following command.
87+
This means, to create an application with the name `MyApplication` for the user `MyUsername`, we need to run the following command.
8788

8889
```bash
89-
pbcli application create Demo --url https://pushbits.example.com --username myusername
90+
pbcli application create MyApplication --url https://pushbits.example.com --username MyUsername
9091
```
9192

9293
You will then be asked for your password interactively.

0 commit comments

Comments
 (0)