diff --git a/README.md b/README.md index a27185f..0bb1810 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ -# rs-base +# autocrate -Base repository for rust projects \ No newline at end of file +![logo](data/media/autocrate.jpeg) + +Release Manager for Your Projects on Gitea, GitHub, and GitLab + +## Purpose +Releasing my cargo workspaces was tedious, so I decided to create a project +that would help me with that. It should create a release with on the git server, +run whatever scripts specified by the maintainers, perhaps integrate with CI/CD, +and upload compiled and otherwise generated artifacts. + +For Rust projects specifically, it should generate binaries and upload them to +the release of the git server. It should also provide the option to generate +the documentation and deploy it to a specified location. (The documentation of +published crates is automatically available on [docs.rs](https://docs.rs)). diff --git a/data/media/autocrate.jpeg b/data/media/autocrate.jpeg new file mode 100644 index 0000000..3798d36 Binary files /dev/null and b/data/media/autocrate.jpeg differ