diff options
author | notgne2 | 2020-09-29 15:10:06 -0700 |
---|---|---|
committer | notgne2 | 2020-09-29 15:10:06 -0700 |
commit | 8d21dd335e5259dadf832a5d1a7c72b9dd1f4400 (patch) | |
tree | bc73e231777d5e0f7f2efa8e9a760a34e95950d1 /README.md | |
parent | e3c55575ca6bfd0c9166c52b4aac76b3761bb313 (diff) |
Add license information, reformat Nix files, clean up
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 25 |
1 files changed, 21 insertions, 4 deletions
@@ -1,16 +1,26 @@ +<!-- +SPDX-FileCopyrightText: 2020 Serokell <https://serokell.io/> + +SPDX-License-Identifier: MPL-2.0 +--> + # deploy-rs -#### A candidate for [serokell/deploy](https://github.com/serokell/deploy) + +A Simple multi-profile Nix-flake deploy tool. **This is very early development software, you should expect to find issues** -## Usage examples +## Usage -Example Nix expressions/configurations are in the [examples folder](./examples), here are various ways to deploy - `nix run github:notgne2/deploy-rs your-flake#node.profile` - `nix run github:notgne2/deploy-rs your-flake#node` - `nix run github:notgne2/deploy-rs your-flake` +## API + +Example Nix expressions/configurations are in the [examples folder](./examples). + ## Idea `deploy-rs` is a simple Rust program that will take a Nix flake and use it to deploy any of your defined profiles to your nodes. This is _strongly_ based off of [serokell/deploy](https://github.com/serokell/deploy), with the intention of eventually replacing it. @@ -21,4 +31,11 @@ This type of design (as opposed to more traditional tools like NixOps or morph) - ~~Ordered profiles~~ - Automatic rollbacks if one profile on node failed to deploy (partially implemented) -- UI (?)
\ No newline at end of file +- UI (?) + +## About Serokell + +deploy-rs is maintained and funded with ❤️ by [Serokell](https://serokell.io/). +The names and logo for Serokell are trademark of Serokell OÜ. + +We love open source software! See [our other projects](https://serokell.io/community?utm_source=github) or [hire us](https://serokell.io/hire-us?utm_source=github) to design, develop and grow your idea!
\ No newline at end of file |