Tidy up initial documentation

Author: sam-lord

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2021 Ghost Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -1,28 +1,42 @@
-# Elasticsearch Bunyan
+# Bunyan Rotating Filestream
 
 ## Install
 
-`npm install elasticsearch-bunyan --save`
+`npm install @tryghost/bunyan-rotating-filestream --save`
 
 or
 
-`yarn add elasticsearch-bunyan`
+`yarn add @tryghost/bunyan-rotating-filestream`
 
 
 ## Usage
 
+Create a bunyan logger using the stream:
+
+```js
+    var log = bunyan.createLogger({
+        name: 'foo',
+        streams: [{
+            stream: new RotatingFileStream({
+                path: '/var/log/foo.log',
+                period: '1d',          // daily rotation
+                totalFiles: 10,        // keep up to 10 back copies
+                rotateExisting: true,  // Give ourselves a clean file when we start up, based on period
+                threshold: '10m',      // Rotate log files larger than 10 megabytes
+                totalSize: '20m',      // Don't keep more than 20mb of archived log files
+                gzip: true             // Compress the archive log files to save space
+            })
+        }]
+    });
+```
+
+Other options include `startNewFile` to always open a new file on start-up.
 
 ## Develop
 
 1. `git clone` this repo & `cd` into it as usual
 2. Run `yarn` to install top-level dependencies.
 
-
-## Run
-
-- `yarn dev`
-
-
 ## Test
 
 - `yarn lint` run just eslint
@@ -36,6 +50,4 @@ or
 
 # Copyright & License 
 
-Copyright (c) 2021 Ghost Foundation. All rights reserved.
-
-This code is considered closed-source and not for distribution. There is no opensource license associated with this project.
+Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE).