doc: updated README.md to reflect latest API changes

- add onekey cli client
- add token based authentication

Author: martonilles

README.md

@@ -1,16 +1,67 @@
 # ONEKEY API Client
 
 This is the official Python client for the
-[ONEKEY](https://www.onekey.com/) public API.
+[ONEKEY](https://www.onekey.com/) public API. This package provides both a cli and a python library.
 
-# Usage
+# Installation
+
+The client is available at https://github.com/onekey-sec/python-client or can be installed as a python package:
+
+```commandline
+pip install onekey-client
+```
+
+# CLI Usage
+
+The client can be used with the onekey command and offers multiple subcommands:
+
+```commandline
+Usage: onekey [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --api-url TEXT        ONEKEY platform API endpoint  [default:
+                        https://app.eu.onekey.com/api]
+  --disable-tls-verify  Disable verifying server certificate, use only for
+                        testing
+  --email TEXT          Email to authenticate on the ONEKEY platform
+  --password TEXT       Password to authenticate on the ONEKEY platform
+  --tenant TEXT         Tenant name on ONEKEY platform
+  --token TEXT          API token to authenticate on the ONEKEY platform
+  --help                Show this message and exit.
+
+Commands:
+  ci-result         Fetch analysis results for CI
+  get-tenant-token  Get tenant specific Bearer token
+  list-tenants      List available tenants
+  upload-firmware   Uploads a firmware to the ONEKEY platform
+```
+
+To use the ONEKEY platform a valid email & password need to be supplied along with specifying the tenant name to be
+used. (SSO authentication is currently not supported.) Preferred alternative is to use a dedicated API token based
+authentication, API tokens can be generated on the ONEKEY platform.
+
+The required parameters can be supplied through command line arguments or using environment variables prefixed with
+`ONEKEY_`, such as the following two are identical:
+
+```commandline
+onekey --email "<email>" --tenant "<tenant-name>" --password "<password>" get-tenant-token
+```
+
+```commandline
+ONEKEY_EMAIL="<email>" ONEKEY_TENANT_NAME="<tenant-name>" ONEKEY_PASSWORD="<password>" onekey get-tenant-token
+```
+
+Environment variables and command line arguments can be also mixed. Using environment variables is useful when the
+client is used from CI/CD jobs/tasks.
+
+# API Usage
 
 First, you have to log in and select a tenant:
 
 ```python
 from onekey_client import Client
 
-YOUR_API_URL = "https://demo.onekey.com/api"
+YOUR_API_URL = "https://app.eu.onekey.com/api"
 
 client = Client(api_url=YOUR_API_URL)
 
@@ -19,6 +70,19 @@ tenant = client.get_tenant("Environment name")
 client.use_tenant(tenant)
 ```
 
+Or use an API Token:
+
+```python
+from onekey_client import Client
+
+YOUR_API_URL = "https://app.eu.onekey.com/api"
+
+client = Client(api_url=YOUR_API_URL)
+
+client.use_token(API_TOKEN)
+```
+
+
 After you logged in and selected the tenant, you can query the GraphQL API
 
 ```python