From 33e2555609e489dda34f8c3edd46a669f5a1b824 Mon Sep 17 00:00:00 2001
From: "John Barton (joho)" <jrbarton@gmail.com>
Date: Wed, 31 Jul 2013 14:16:18 +1000
Subject: [PATCH] Licence and more readme

---
 LICENCE   | 23 ++++++++++++++++++++
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 2 files changed, 82 insertions(+), 4 deletions(-)
 create mode 100644 LICENCE

diff --git a/LICENCE b/LICENCE
new file mode 100644
index 0000000..e7ddd51
--- /dev/null
+++ b/LICENCE
@@ -0,0 +1,23 @@
+Copyright (c) 2013 John Barton
+
+MIT License
+
+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.
+
diff --git a/README.md b/README.md
index f8973f5..4ebf0e4 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,60 @@
-# GoDotEnv
-## A Go (golang) port of the Ruby dotenv project (which loads env vars from a .env file)
+# GoDotEnv [![wercker status](https://app.wercker.com/status/507594c2ec7e60f19403a568dfea0f78/m "wercker status")](https://app.wercker.com/project/bykey/507594c2ec7e60f19403a568dfea0f78)
 
-## Build Status
-[![wercker status](https://app.wercker.com/status/507594c2ec7e60f19403a568dfea0f78/m "wercker status")](https://app.wercker.com/project/bykey/507594c2ec7e60f19403a568dfea0f78)
+A Go (golang) port of the Ruby dotenv project (which loads env vars from a .env file)
+
+## Installation
+
+```shell
+go get github.com/joho/godotenv
+```
+
+## Usage
+
+Add your application configuration to your `.env` file in the root of your project:
+
+```shell
+S3_BUCKET=YOURS3BUCKET
+SECRET_KEY=YOURSECRETKEYGOESHERE
+```
+
+Then in your Go app you can do something like
+
+```go
+import (
+    "github.com/joho/godotenv"
+    "os"
+)
+
+err := godotenv.Load()
+if err != nil {
+  os.Fatal("Error loading .env file")
+}
+
+s3Bucket := os.Getenv("S3_BUCKET")
+secretKey := os.Getenv("SECRET_KEY")
+```
+
+While `.env` in the project root is the default, you don't have to be constrained
+
+```go
+_ := godotenv.Load("somerandomfile")
+_ := godotenv.Load("filenumberone.env", "filenumbertwo.env")
+```
+
+Are all valid options
+
+## Contributing
+
+Contributions are most welcome! The parser itself is pretty stupidly naive and I wouldn't be surprised if it breaks with edge cases.
+
+*code changes without tests will not be accepted*
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Who?
+
+The original library [dotenv](https://github.com/bkeepers/dotenv) was written by [Brandon Keepers](http://opensoul.org/), and this port was done by [John Barton](http://whoisjohnbarton.com) based off the tests/fixtures in the original library.