Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add readme #64

Merged
merged 4 commits into from
Mar 14, 2022
Merged

docs: add readme #64

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ad002c
docs: add readme
brokad Mar 14, 2022
fb2f10b
Update link
brokad Mar 14, 2022
b715df3
WIP
brokad Mar 14, 2022
5f284a1
WIP
brokad Mar 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: add readme
  • Loading branch information
@brokad
brokad committed Mar 14, 2022
commit 1ad002cd5c72449fd3ed644b5c23141b43480ee1
54 changes: 54 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<p align="center">
<img width="300" src="https://raw.githubusercontent.com/getsynth/shuttle/master/resources/logo-rectangle-transparent.png"/>
</p>
<br>
<p align=center>
<a href="https://docs.rs/shuttle-service">
<img alt="docs" src="https://img.shields.io/badge/doc-reference-orange">
</a>
<a href="https://github.com/getsynth/shuttle/search?l=rust">
<img alt="language" src="https://img.shields.io/badge/language-Rust-orange.svg">
</a>
<a href="https://github.com/getsynth/shuttle/actions">
<img alt="build status" src="https://img.shields.io/github/workflow/status/getsynth/shuttle/cargo_test"/>
</a>
<a href="https://discord.gg/H33rRDTm3p">
<img alt="discord" src="https://img.shields.io/discord/803236282088161321?logo=discord"/>
</a>
</p>

---

# shuttle

[shuttle](https://shuttle.rs) is a crate that uses traits and annotations to configure your backend deployment - including databases.

- [x] Deploy a Rocket service
- [x] Postgres support
- [ ] Authentication and authorization
- [ ] Storage
- [ ] ORM support
- [ ] GitOps

## Documentation

For full documentation, visit [docs.rs/shuttle-service](https://docs.rs/shuttle-service)

## Community & Support

- [Community Forum](https://github.com/getsynth/shuttle/discussions). Best for: help with building, discussion about best practices.
- [GitHub Issues](https://github.com/getsynth/shuttle/issues). Best for: bugs and errors you encounter using Shuttle.
- [Discord](https://discord.gg/H33rRDTm3p). Best for: sharing your applications and hanging out with the community.

## Status

- [x] Alpha: We are testing shuttle, API and deployments may be unstable
- [ ] Public Alpha: Anyone can sign up (link is coming). But go easy on us, there are a few kinks
- [ ] Public Beta: Stable enough for most non-enterprise use-cases
- [ ] Public: Production-ready!

We are currently in Alpha. Watch "releases" of this repo to get notified of major updates!

<kbd><img src="https://gitcdn.link/repo/getsynth/shuttle/master/web/static/watch-repo.gif" alt="Watch this repo"/></kbd>

---