diff --git a/README.md b/README.md index 944c3efa5e635b25cdea8ede7bd4558a2b3e25ee..e1e23a84f2b6dbeee7b1962042a3d7dc8c6d812f 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,20 @@ A real simple logger application ## Usage - - `const log = require('log')(options)` Note: The options Part may be omitted, as all parts are optional, but using the name is recommended, as without it, the folder-name will be used -Options: +### Methods + +`log.info('This is an Information')` +`log.warn('This is a Warning')` +`log.error('This is an Error')` +`log.debug('This is a Debug Message')` + +### Options +```json { name: 'Name of App', hostname: 'Server Hostname', @@ -26,4 +32,5 @@ Options: port: 'graylog-port' } ] -} \ No newline at end of file +} +``` \ No newline at end of file