diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..8545b78 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Daniel Gerlag + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/readme.md b/readme.md index 690aafe..315ec7f 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -## Conductor +# Conductor Conductor is a workflow server built upon [Workflow Core](https://github.com/danielgerlag/workflow-core) that enables you to coordinate multiple services and scripts into workflows so that you can rapidly create complex workflow applications. Workflows are made up of a series of steps, with an internal data object shared between them to pass information around. Conductor automatically runs and tracks each step, and retries when there are errors. @@ -44,7 +44,7 @@ services: image: mongo ``` -### Defining a workflow +### Quick example We'll start by defining a simple workflow that will log "Hello world" as it's first step and then "Goodbye!!!" as it's second and final step. We `POST` the definition to `api/definition` in either `YAML` or `JSON`. @@ -96,6 +96,11 @@ Content-Type: application/x-yaml CustomMessage: foobar ``` +## Status + +This project is currently in aphla status. I'm seeking passionate and talented to help get it to v1. Please [contact me](mailto:daniel@gerlag.ca) if you are interested in getting involved. + + ## Further reading * [Introduction](docs/01-intro.md) * [Workflow Primitives](docs/02-primitives.md) @@ -103,3 +108,8 @@ CustomMessage: foobar * [Lambdas](docs/04-lambda.md) * [API Reference](docs/99-api-reference.md) * [Roadmap](docs/roadmap.md) + + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details