Skip to content

Commit

Permalink
polish docs
Browse files Browse the repository at this point in the history
  • Loading branch information
m1guelpf committed Jul 23, 2024
1 parent f45bcce commit b582037
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ members = ["crates/*"]
[workspace.package]
license = "MIT"
edition = "2021"
readme = "README.md"
repository = "https://github.com/m1guelpf/orbit"
authors = ["Miguel Piedrafita <[email protected]>"]

[profile.release]
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ token = "" # Use `openssl rand -base64 32` to generate a random token
name = "Test Site"
path = "/var/www/test-site"
github_repo = "m1guelpf/laravel-test"
commands = [ # Extra commands to run during the deployment (optional)
"php horizon:terminate"
]
```

3. Create a `.github/workflows/deploy.yaml` GitHub action, like so:
Expand Down
3 changes: 3 additions & 0 deletions crates/cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@
version = "0.1.0"
name = "orbit-cli"
categories = ["command-line-utilities"]
description = "Command-line tool to easily deploy Laravel sites using Orbit."

readme.workspace = true
edition.workspace = true
license.workspace = true
authors.workspace = true
repository.workspace = true

[dependencies]
url = "2.5.2"
Expand Down
5 changes: 5 additions & 0 deletions crates/client/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
[package]
version = "0.1.0"
name = "orbit-client"
description = "An API client for the Orbit Server API"

readme.workspace = true
edition.workspace = true
license.workspace = true
authors.workspace = true
repository.workspace = true

[dependencies]
url = "2.5.2"
Expand Down
4 changes: 4 additions & 0 deletions crates/server/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
[package]
version = "0.1.0"
name = "orbit-server"
description = "Orbit enables simple & secure zero-downtime deployments for your Laravel apps."

readme.workspace = true
license.workspace = true
edition.workspace = true
authors.workspace = true
repository.workspace = true

[dependencies]
axum = "0.7.5"
Expand Down
5 changes: 5 additions & 0 deletions crates/types/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
[package]
version = "0.1.0"
name = "orbit-types"
description = "Shared types for Orbit."


readme.workspace = true
license.workspace = true
edition.workspace = true
authors.workspace = true
repository.workspace = true

[dependencies]
thiserror = "1.0.63"
Expand Down

0 comments on commit b582037

Please sign in to comment.