Skip to content

Commit

Permalink
Update github readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenca committed Oct 10, 2011
1 parent 791c7a1 commit 543726f
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.txt
Expand Up @@ -47,6 +47,9 @@ DESCRIPTION
Peters. The three-signature behaviour of config() is also borrowed from Peters. The three-signature behaviour of config() is also borrowed from
Michael's implementation. Michael's implementation.


This module is hosted on github:
<https://github.com/stephenca/CGI-Application-Plugin-Config-Std>.

METHODS METHODS
config_param() config_param()
This method acts as an accessor/mutator for configuration variables This method acts as an accessor/mutator for configuration variables
Expand All @@ -60,8 +63,7 @@ METHODS
with parameter, or undef if none exists. Note that 'dot' notation parameters with parameter, or undef if none exists. Note that 'dot' notation parameters
are supported, e.g. $self->config_param('foo.bar') will be translated to are supported, e.g. $self->config_param('foo.bar') will be translated to
something like $conf->{foo}{bar}. something like $conf->{foo}{bar}.
- more than 1 parameter: treated as name/value pairs, and will be set in the - more than 1 parameter: treated as name/value pairs. Returns true if successful. The same 'dot notation'
config file accordingly. Returns true if successful. The same 'dot notation'
is supported as per a single paremeter. Existing config params will be is supported as per a single paremeter. Existing config params will be
over-written by this form of the method call. over-written by this form of the method call.


Expand All @@ -77,6 +79,16 @@ METHODS
config_file() method or the CGIAPP_CONFIG_FILE environment variable config_file() method or the CGIAPP_CONFIG_FILE environment variable
before calling this method it will generate a fatal exception. before calling this method it will generate a fatal exception.


commit_config
This method writes the current contents of the configuration object back
to the config file (possibly a different one to that from which the
config was read).

Returns the current configuration object on success. A fatal exception
is raised if the write fails.

This method is potentially dangerous, so is not exported by default.

config() config()
This method will return the underlying Config::Std object for more This method will return the underlying Config::Std object for more
direct use by your application. direct use by your application.
Expand Down Expand Up @@ -134,3 +146,7 @@ SEE ALSO


* Config::Std * Config::Std


BUGS
Please use github for bug reports:
<https://github.com/stephenca/CGI-Application-Plugin-Config-Std/issues>

0 comments on commit 543726f

Please sign in to comment.