Skip to content

Commit ab15e54

Browse files
committed
Merge pull request #17 from bry4n/patch-1
Update README.md
2 parents 4f8c6ed + 72c7d8a commit ab15e54

File tree

1 file changed

+45
-39
lines changed

1 file changed

+45
-39
lines changed

README.md

+45-39
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ Installation
1111

1212
$ sudo gem install parseconfig
1313

14+
Gemfile
15+
16+
gem 'parseconfig'
17+
1418
Usage
1519
-----
1620

@@ -31,49 +35,51 @@ An example configuration file might look like:
3135

3236
Access it with ParseConfig:
3337

34-
>> require('parseconfig.rb')
35-
=> true
38+
```ruby
39+
40+
>> require 'parseconfig'
41+
=> true
3642

37-
>> config = ParseConfig.new('/path/to/config/file')
38-
=> #<ParseConfig:0x102410908
39-
@config_file="example.conf",
40-
@groups=["group1", "group2"],
41-
@params={
43+
>> config = ParseConfig.new('/path/to/config/example.conf')
44+
=> #<ParseConfig:0x102410908
45+
@config_file="example.conf",
46+
@groups=["group1", "group2"],
47+
@params={
48+
"param1"=>"value1"
49+
"param2"=>"value2",
50+
"group1"=>{
4251
"param1"=>"value1"
4352
"param2"=>"value2",
44-
"group1"=>{
45-
"param1"=>"value1"
46-
"param2"=>"value2",
47-
},
48-
"group2"=>{
49-
"param1"=>"value1"
50-
"param2"=>"value2",
51-
},
52-
}
53-
>
54-
55-
>> config.get_params()
56-
=> ["param1", "param2", "group1", "group2"]
57-
58-
>> config['param1']
59-
=> "value1"
60-
61-
>> config.get_groups()
62-
=> ["group1", "group2"]
63-
64-
>> config['group1']
65-
=> {"group1_param1"=>"group1_value1", "group1_param2"=>"group1_value2"}
66-
67-
>> config['group1']['group1_param1']
68-
=> "group1_value1"
69-
70-
>> file = File.open('/path/to/config/file', 'w')
71-
=> #<File:file>
72-
>> config.write(file)
73-
=> []
74-
>> file.close
75-
=> nil
53+
},
54+
"group2"=>{
55+
"param1"=>"value1"
56+
"param2"=>"value2",
57+
},
58+
}>
59+
60+
>> config.get_params
61+
=> ["param1", "param2", "group1", "group2"]
62+
63+
>> config['param1']
64+
=> "value1"
65+
66+
>> config.get_groups
67+
=> ["group1", "group2"]
68+
69+
>> config['group1']
70+
=> {"group1_param1"=>"group1_value1", "group1_param2"=>"group1_value2"}
71+
72+
>> config['group1']['group1_param1']
73+
=> "group1_value1"
74+
75+
>> file = File.open('/path/to/config/file', 'w')
76+
=> #<File:file>
77+
>> config.write(file)
78+
=> []
79+
>> file.close
80+
=> nil
7681

82+
```
7783

7884
License
7985
-------

0 commit comments

Comments
 (0)