floratest9/StableStudio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

better readme

Browse Source
This commit is contained in:
kaj
2023-05-22 09:35:59 -08:00
parent 46fd12f6e4
commit e3e58b6707
1 changed files with 23 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@@ -1,18 +1,21 @@
<div align="center">
![StableStudio](./misc/Banner.png)
# StableStudio by [Stability AI](https://stability.ai/)
# StableStudio
**👋 Welcome to the community repository for StableStudio, the open-source version of [DreamStudio](https://www.dreamstudio.ai)**
**🗺 Contents – [🚀 Quick Start](#quick-start) · [ℹ️ About](#about) · [🙋 FAQ](#faq) · [🧑‍💻 Contributing](#contributing)**
## Documentation
[🎨 UI](./packages/stablestudio-ui/README.md)
[🔌 Plugins](./packages/stablestudio-plugin/README.md)
**📚 Documentation – [🎨 UI](./packages/stablestudio-ui/README.md) · [🔌 Plugins](./packages/stablestudio-plugin/README.md) · <a href="https://platform.stability.ai" target="_blank">⚡️ platform.stability.ai</a>**
## Links
<a href="https://discord.gg/stablediffusion" target="_blank">🎮 Discord</a>
**🔗 Links – <a href="https://discord.com/channels/1002292111942635562/1108055793674227782" target="_blank">🎮 Discord</a> · <a href="https://dreamstudio.ai" target="_blank">🌈 DreamStudio</a> · <a href="https://github.com/Stability-AI/StableStudio/issues">🛟 Bugs & Support</a> · <a href="https://github.com/Stability-AI/StableStudio/discussions">💬 Discussion</a>**
<a href="https://github.com/Stability-AI/StableStudio/issues">🛟 Bugs & Support</a>
</div>
<a href="https://github.com/Stability-AI/StableStudio/discussions">💬 Discussion</a>
<div align="center" style="display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 1em; margin: 4em 0;">
<img src="./misc/GenerateScreenshot.png" style="width: 400px; max-width: 600px; flex-grow: 1;" />
@@ -27,11 +30,14 @@ Once that's done, you can run the following commands...
```bash
git clone https://github.com/Stability-AI/StableStudio.git
```
```bash
cd StableStudio
```
```bash
yarn
```
```bash
yarn dev
```
@@ -39,23 +45,17 @@ _**That's it! 🎉**_
StableStudio will be running at [localhost:3000](http://localhost:3000) by default.
You'll need to have your [API key](https://platform.stability.ai/docs/getting-started/authentication) handy to use the default [Stability API](https://platform.stability.ai/docs/getting-started) plugin.
> If you are using the default Stability API plugin, You'll need to have your [API key](https://platform.stability.ai/docs/getting-started/authentication) handy, otherwise you should be good to go!
If you don't have one, you can create an account on [DreamStudio](https://dreamstudio.ai) and get a key from the [account page](https://dreamstudio.ai/account).
# <a id="about" href="#about">ℹ️ About</a>
# <a id="about" href="#about">About</a>
<div style="display: flex; justify-content: center; align-items: center; gap: 1em; margin: 0 0 2em 0;">
<img src="./misc/PainterWithRobot.png" style="flex-grow: 1; flex-shrink: 1;" />
</div>
StableStudio is [Stability AI](https://stability.ai)'s official open-source variant of [DreamStudio](https://www.dreamstudio.ai), our user interface for generative AI.
StableStudio is [Stability AI](https://stability.ai)'s official open-source variant of [DreamStudio](https://www.dreamstudio.ai), our user interface for generative AI. It is a web-based application that allows users to create and edit generated images. We're not entirely sure where this project is going just yet, but we're excited to see what the community does with it!
It is a web-based application that allows users to create and edit generated images.
We're not entirely sure where this project is going just yet, but we're excited to see what the community does with it!
# <a id="faq" href="#faq">🙋 FAQ</a>
# <a id="faq" href="#faq">FAQ</a>
## What's the difference between StableStudio and [DreamStudio](https://dreamstudio.ai)?
@@ -65,7 +65,7 @@ _Not much!_ There are a few tweaks we made to make the project more community-fr
- All "over-the-wire" API calls have been replaced by a [plugin system](./packages/stablestudio-plugin/README.md) which allows you to easily swap out the back-end.
- On release, we'll only be providing a plugin for the Stability API, but with a little bit of TypeScript, you can [create your own](./packages/stablestudio-plugin/README.md).
- with a little bit of TypeScript, you can [create your own](./packages/stablestudio-plugin/README.md) plugin and use StableStudio with any backend you want!
- We removed Stability-specific account features such as billing, API key management, etc.
@@ -73,9 +73,7 @@ _Not much!_ There are a few tweaks we made to make the project more community-fr
## Will [DreamStudio](https://dreamstudio.ai) still be supported?
_Yes!_ Stability's hosted deployment of StableStudio will remain [DreamStudio](https://dreamstudio.ai).
It will continue to get updates and stay up-to-date with StableStudio whenever possible.
_Yes!_ Stability's hosted deployment of StableStudio will remain [DreamStudio](https://dreamstudio.ai). It will continue to get updates and stay up-to-date with StableStudio whenever possible.
# <a id="contributing" href="#contributing">🧑‍💻 Contributing</a>
@@ -85,9 +83,7 @@ It will continue to get updates and stay up-to-date with StableStudio whenever p
_**Community contributions are encouraged!**_
_**The UI package's [README](./packages/stablestudio-ui/README.md) is a great place to start.**_
Bug fixes, documentation, general clean-up, new features, etc. are all welcome.
**The UI package's [README](./packages/stablestudio-ui/README.md) is a great place to start.** Bug fixes, documentation, general clean-up, new features, etc. are all welcome.
Here are some useful links...