diff --git a/README.md b/README.md index a9955cff..12d8dbe6 100644 --- a/README.md +++ b/README.md @@ -27,22 +27,13 @@ Please look in the [examples/](examples/) folder for more examples! ## Documentation: Please see: [DOCUMENTATION.md](DOCUMENTATION.md) or [PDF](https://pdfdoc-purpleidea.rhcloud.com/pdf/https://github.com/purpleidea/mgmt/blob/master/DOCUMENTATION.md). +## Roadmap: +Please see: [TODO.md](TODO.md) for a list of upcoming work and TODO items. +Please get involved by working on one of these items or by suggesting something else! + ## Bugs: Please set the `DEBUG` constant in [main.go](https://github.com/purpleidea/mgmt/blob/master/main.go) to `true`, and post the logs when you report the [issue](https://github.com/purpleidea/mgmt/issues). Bonus points if you provide a [shell](https://github.com/purpleidea/mgmt/tree/master/test/shell) or [OMV](https://github.com/purpleidea/mgmt/tree/master/test/omv) reproducible test case. -There are currently a few known bugs which I hope to squash soon. - -## Notes: -* This is currently a research project into next generation config management technologies! -* This is my first complex project in golang, please notify me of any issues. -* I have some well thought out designs for the future of this project, which I'll try and write up clearly and publish as soon as possible. -* The interfaces and code are not yet stable. Please run in development environments only! -* This design is the result of ideas I've had from hacking on advanced config management projects. -* I first started hacking on this in ~2013, even though I had very little time for it. -* I've published a number of articles about this tool: - * [https://ttboj.wordpress.com/2016/01/18/next-generation-configuration-mgmt/](https://ttboj.wordpress.com/2016/01/18/next-generation-configuration-mgmt/) -* There are some screencasts available: - * TODO ## Dependencies: * golang 1.4 or higher (required, available in most distros) @@ -63,7 +54,11 @@ There are currently a few known bugs which I hope to squash soon. * graphviz (optional, for building a visual representation of the graph) ## Patches: -We'd love to have your patch! Please send it by email, or as a pull request. +We'd love to have your patches! Please send them by email, or as a pull request. + +## On the web: +* Introductory blog post: [https://ttboj.wordpress.com/2016/01/18/next-generation-configuration-mgmt/](https://ttboj.wordpress.com/2016/01/18/next-generation-configuration-mgmt/) +* Julian Dunn at Cfgmgmtcamp 2016 [https://www.youtube.com/watch?v=kfF9IATUask&t=1949&html5=1](https://www.youtube.com/watch?v=kfF9IATUask&t=1949&html5=1) ##