From 25fc8dbc337356ca1d726cebc3d0b081e02499f6 Mon Sep 17 00:00:00 2001
From: Александр Кирюхин <alexander@kiryukhin.su>
Date: Fri, 19 Jan 2018 03:41:53 +0300
Subject: Readme and license

---
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..be2fc90
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+# Dotenv
+
+[![Build Status](https://travis-ci.org/NeonXP/Dotenv.svg?branch=master)](https://travis-ci.org/NeonXP/Dotenv)
+[![Coveralls github](https://img.shields.io/coveralls/github/NeonXP/Dotenv.svg)]()
+[![GitHub issues](https://img.shields.io/github/issues/neonxp/dotenv.svg)](https://github.com/neonxp/dotenv/issues)
+[![GitHub forks](https://img.shields.io/github/forks/neonxp/dotenv.svg)](https://github.com/neonxp/dotenv/network)
+[![GitHub stars](https://img.shields.io/github/stars/neonxp/dotenv.svg)](https://github.com/neonxp/dotenv/stargazers)
+[![GitHub license](https://img.shields.io/github/license/neonxp/dotenv.svg)](https://github.com/neonxp/dotenv)
+
+## What is it?
+
+Small library, that automaticaly loads `.env` (or any other) file to applications environment.
+
+## Why not XXX?
+
+Because this library is pretty simple, without external dependencies and highly customizable.
+
+## Installation
+
+```
+composer require neonxp/dotenv
+``` 
+
+## Usage
+
+Basic usage:
+
+```php
+use NeonXP\Dotenv\Dotenv;
+
+$dotenv = new Dotenv();
+$dotenv->load(); // You can specify file to load at first argument
+
+print $dotenv->get('KEY', 'default') . PHP_EOL;
+print $dotenv['KEY'] . PHP_EOL;
+foreach ($dotenv as $key => $value) {
+    print "$key = $value" . PHP_EOL;
+}
+```
+
+## .env file syntax
+
+Here examples of syntax:
+
+```
+# This is a comment
+
+# Empty lines also ignored
+export KEY1=VALUE1
+KEY2 = VALUE2 # Inline comment
+KEY3 = 'VALUE3 # This is not comment'
+KEY4 = "VALUE4 # And this value too"
+KEY5 = ${KEY1} -> ${KEY2} # Compilled from another variables
+```
+
+and we will get:
+
+```php
+[
+    'KEY1' => 'VALUE1',
+    'KEY2' => 'VALUE2',
+    'KEY3' => 'VALUE3 # This is not comment',
+    'KEY4' => 'VALUE4 # And this value too',
+    'KEY5' => 'VALUE1 -> VALUE2',
+]
+```
\ No newline at end of file
-- 
cgit v1.2.3