search

riverqueue / riverui

A web interface for River, fast and reliable background jobs in Go.
https://ui.riverqueue.com/
Mozilla Public License 2.0
43 stars 3 forks source link

Add install instructions to the README #48

Closed brandur closed 1 week ago

brandur commented 1 week ago

Change the README to consist mainly of a description of the project along with install instructions with binaries and container images, which will be more useful to most people looking at the project.

In sitting with the same convention as River, move development instructions to ./docs/development.md and also move the README.md into ./docs so that we can have separate documentation for the top-level Go package.

brandur commented 1 week ago

@bgentry This is pretty much what I'm thinking for the official docs site as well. The README/docs will basically be mirrors of each other for now.