Skip to content

Commit 4522ee5

Browse files
Clean-up SDK README.md (#198)
Add reference to Platform site, clean up outdated references.
1 parent f01a647 commit 4522ee5

1 file changed

Lines changed: 13 additions & 17 deletions

File tree

README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22

33
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/stability-ai/stability-sdk/blob/main/nbs/demo_colab.ipynb)
44

5-
Client implementations that interact with the Stability Generator API
5+
Client implementations that interact with the Stability API.
66

7-
# Installation
7+
## Getting an API key
88

9-
Install the PyPI package via:
9+
Follow the [instructions](https://platform.stability.ai/docs/getting-started/authentication) on [Platform](https://platform.stability.ai) to obtain an API key.
1010

11-
`pip install stability-sdk`
11+
## PyPI Package Installation
12+
13+
Install the [PyPI](https://pypi.org/project/stability-sdk/) package via:
1214

13-
# Getting an API key
14-
You can manage API keys in your dreamstudio account [here](https://beta.dreamstudio.ai/membership?tab=apiKeys)
15+
`pip install stability-sdk`
1516

16-
# Python client
17+
## Python Client
1718

1819
`client.py` is both a command line client and an API class that wraps the gRPC based API. To try the client:
1920

@@ -34,7 +35,7 @@ To upscale:
3435

3536
## SDK Usage
3637

37-
See usage demo notebooks in ./nbs
38+
Be sure to check out [Platform](https://platform.stability.ai) for comprehensive documentation on how to interact with our API.
3839

3940
## Command line usage
4041

@@ -112,11 +113,7 @@ options:
112113

113114
## Connecting to the API using languages other than Python
114115

115-
The `src` subdirectory contains pre-compiled gRPC stubs for the following languages:
116-
117-
- [Javascript/Typescript](https://github.com/Stability-AI/stability-sdk/tree/main/src/js)
118-
119-
If a language you would like to connect to the API with is not listed above, you can use the following
116+
If a language you would like to connect to the API with is not currently documented on [Platform](https://platform.stability.ai) you can use the following
120117
protobuf definition to compile stubs for your language:
121118

122119
- [protobuf spec](https://github.com/Stability-AI/api-interfaces/blob/main/src/proto/)
@@ -126,8 +123,7 @@ protobuf definition to compile stubs for your language:
126123
* Typescript client: https://github.com/jakiestfu/stability-ts
127124
* Guide to building for Ruby: https://github.com/kmcphillips/stability-sdk/blob/main/src/ruby/README.md
128125

129-
## DreamStudio API TOS
130-
131-
Unless otherwise specified, usage of the dreamstudio API falls under the same usage terms as the dreamstudio web interface:
126+
## Stability API TOS
132127

133-
* https://beta.dreamstudio.ai/terms-of-service
128+
Usage of the Stability API falls under the [STABILITY AI API Terms of Service.
129+
](https://platform.stability.ai/docs/terms-of-service)

0 commit comments

Comments
 (0)