Skip to content

Commit

Permalink
Update readme and cargo prepping for release
Browse files Browse the repository at this point in the history
  • Loading branch information
mlieberman85 committed Apr 15, 2024
1 parent dcd3065 commit ef4aee7
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 0 deletions.
4 changes: 4 additions & 0 deletions skootrs-bin/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
name = "skootrs-bin"
version = "0.1.0"
edition = "2021"
description = "This module is for the Skootrs CLI tool binary and helper functions."
license = "Apache-2.0"
repository = "https://github.com/kusaridev/skootrs"


[[bin]]
name = "skootrs"
Expand Down
3 changes: 3 additions & 0 deletions skootrs-bin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Skootrs-bin

This module is for the Skootrs CLI tool binary and helper functions.
3 changes: 3 additions & 0 deletions skootrs-lib/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
name = "skootrs-lib"
version = "0.1.0"
edition = "2021"
description = "This module contains most of the core functionality for Skootrs. It contains the code to interact with repo hosts, generate files, manage projects, etc."
license = "Apache-2.0"
repository = "https://github.com/kusaridev/skootrs"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
3 changes: 3 additions & 0 deletions skootrs-lib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Skootrs-lib

This module contains most of the core functionality for Skootrs. It contains the code to interact with repo hosts, generate files, manage projects, etc.
3 changes: 3 additions & 0 deletions skootrs-model/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
name = "skootrs-model"
version = "0.1.0"
edition = "2021"
description = "This module contains the various data structures used by the other Skootrs modules. This is also setup to make it easy to generate schemas from this code for the purposes of easily implementing Skootrs API compliant clients in other languages and systems."
license = "Apache-2.0"
repository = "https://github.com/kusaridev/skootrs"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
5 changes: 5 additions & 0 deletions skootrs-model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Skootrs-model

This module contains the various data structures used by the other Skootrs modules. This is also setup to make it easy to generate schemas from this code for the purposes of easily implementing Skootrs API compliant clients in other languages and systems.

Over time this will probably transform into more of an SDK.
3 changes: 3 additions & 0 deletions skootrs-rest/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
name = "skootrs-rest"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"
description = "This is an experimental module is for a REST API for Skootrs."
repository = "https://github.com/kusaridev/skootrs"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
3 changes: 3 additions & 0 deletions skootrs-rest/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Skootrs-rest

This is an experimental module is for a REST API that is a Skootrs implementation. Over time this will evolve into the main mechanism for handling Skootrs project management and the CLI will just connect to a local running service running the API.
3 changes: 3 additions & 0 deletions skootrs-statestore/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
name = "skootrs-statestore"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"
description = "This module contains code for managing the state of Skootrs projects as well as the state across all known Skootrs project for a particular installation of Skootrs."
repository = "https://github.com/kusaridev/skootrs"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
3 changes: 3 additions & 0 deletions skootrs-statestore/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Skootrs-statestore

This module contains code for managing the state of Skootrs projects as well as the state across all known Skootrs project for a particular installation of Skootrs.

0 comments on commit ef4aee7

Please sign in to comment.