diff --git a/docs/index.rst b/docs/index.rst index 3feb26c..4831bef 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,7 @@ mostly self-contained module of your application that can start/stop/reload, contain other services, manage async operations, and expose configuration. :: + class ExampleService(Service): setting = Setting("example.setting", default="Foobar") diff --git a/docs/user/install.rst b/docs/user/install.rst index 1d6ca67..8995809 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -9,19 +9,23 @@ Get the Code You can either clone the public repository: :: + $ git clone git://github.com/progrium/ginkgo.git Download the tarball: :: + $ curl -OL https://github.com/progrium/ginkgo/tarball/master Or, download the zipball: :: + $ curl -OL https://github.com/progrium/ginkgo/zipball/master Once you have a copy of the source, you can embed it in your Python package, or install it into your site-packages easily: :: + $ python setup.py install diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index 31b4829..0a25985 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -34,10 +34,12 @@ With this module you now have a configurable, daemonizable server ready to be deployed. Ginkgo gives you a simple runner to execute your app: :: + $ ginkgo server.NumberServer As well as a more full featured service management tool: :: + $ ginkgoctl server.NumberServer start