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

Add docs.rs links to README #105

Merged
merged 1 commit into from
Apr 15, 2024
Merged

Add docs.rs links to README #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,12 @@ A CLI tool for creating secure-by-design/default source repos.

## Installing

For releases you can download the `skootrs` binary from releases.
For releases you can download the `skootrs` binary from releases or run `cargo install skootrs-bin`

For dev you can clone this repo and run `cargo install --path skootrs-bin` from the root of the repo.

## Running Skootrs

Skootrs is currently pre-release so you will need to use cargo to compile and run Skootrs yourself.

```shell
$ cargo run
Skootrs is a CLI tool for creating and managing secure-by-default projects. The commands are using noun-verb syntax. So the commands are structured like: `skootrs <noun> <verb>`. For example, `skootrs project create`
Expand Down Expand Up @@ -111,6 +109,14 @@ $ cargo run project create | bunyan
[2024-02-08T05:34:11.676Z] INFO: skootrs/16973 on Michaels-MBP-2.localdomain: Writing file SECURITY.md to ./ (file=skootrs-lib/src/service/facet.rs,line=115,target=skootrs_lib::service::facet)
```

## Library docs:

- https://docs.rs/skootrs-statestore/latest/skootrs_statestore/
- https://docs.rs/skootrs-model/latest/skootrs_model/
- https://docs.rs/skootrs-rest/latest/skootrs_rest/
- https://docs.rs/skootrs-lib/latest/skootrs_lib/


The initial talk given on Skootrs appears to not have been recorded but here are the locations of slides that include the reason why Skootrs is being built along with some architecture:

- [OpenSSF Day Japan 2023](https://github.com/mlieberman85/talks/blob/91cf3bef51f7d277a744098863389e362920b4c8/2023-12-04-ossfday/presentation.pdf)
Expand Down