localhots
/
secondly
1
0
Fork 0
Code Releases Activity

Readme fix #3

This commit is contained in:
Gregory Eremin 2015-08-29 22:04:52 +03:00
parent be052e2c75
commit 604d201c28
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,12 +1,12 @@
# Secondly # Secondly
Secondly is a configuration management plugin for Go projects. It taks care of Secondly is a configuration management plugin for Go projects. It takes care of
the app's configuration, specifically of updating it in runtime. the app's configuration, specifically of updating it in runtime.
## Configuration ## Configuration
First we need to define a struct that will hold app's configuration. Let's make First, we need to define a struct that will hold the app's configuration. Let's
it simple for demostration purposes. make it simple for demonstration purposes.
```go ```go
type Config struct { type Config struct {
@ -15,9 +15,9 @@ type Config struct {
} }
``` ```
Make sure you've defined `json` tags on each field. Make sure you've added `json` tags to each field.
Next, right where you will define your app's flags ask Secondly to add one for Next, right where you will define your app's flags, ask Secondly to add one for
configuration file. configuration file.
```go ```go
@ -41,8 +41,8 @@ secondly.Manage(&conf)
go secondly.Manage(&conf) go secondly.Manage(&conf)
``` ```
If you prefer to configure the app asynchronously then you'll probably want to If you prefer to configure the app asynchronously, then you'll probably want to
know when configuration is loaded, so there's a handly helper function just for know when configuration is loaded, so there's a handy helper function just for
that: that:
```go ```go
@ -75,10 +75,11 @@ secondly.HandleSIGHUP()
``` ```
You can also set up callback functions on specific fields and receive a call You can also set up callback functions on specific fields and receive a call
when this fields value changes. when this field's value changes.
```go ```go
secondly.OnChange("NumWorkers", func(oldVal, newVal interface{}) { // Refer to a field using its json tag
secondly.OnChange("num_workers", func(oldVal, newVal interface{}) {
old := oldVal.(int) old := oldVal.(int)
cur := newVal.(int) cur := newVal.(int)
if cur > old { if cur > old {
@ -99,7 +100,7 @@ Full example can be found [here](https://github.com/localhots/secondly/blob/mast
## Building ## Building
The only thing to keep in mind when building Secndly is to convert assets into a The only thing to keep in mind when building Secondly is to convert assets into a
binary form so they could be kept in memory of your app and would not require binary form so they could be kept in memory of your app and would not require
any additional web server configuration. any additional web server configuration.