Version 0.1.1 release

CHANGELOG.md

@@ -9,6 +9,11 @@ We follow Semantic Versions.
 
 - Fixes how homepage in defined in `pyproject.toml`
 
+### Misc
+
+- Improves docs: adds examples and usage section to the `README.md`
+- Changes state: from Alpha to Beta
+
 
 ## Version 0.1.0
 

README.md

@@ -14,11 +14,39 @@ Simple linter for `.env` files.
 While `.env` files are very simple it is required to keep them consistent.
 This tool offers a wide range of consistency rules and best practices.
 
-And it integrates perfectly for any existing workflow.
+And it integrates perfectly to any existing workflow.
 
 
 ## Installation
 
 ```bash
 pip install dotenv-linter
 ```
+
+See [Usage](https://dotenv-linter.readthedocs.io/en/latest/#usage)
+section to get started.
+
+
+## Examples
+
+There are many things that can go wrong in your `.env` files:
+
+```env
+# Next line has leading space which will be removed:
+ SPACED=
+
+# Equal signs should not be spaced:
+KEY = VALUE
+
+# Quotes won't be preserved after parsing, do not use them:
+SECRET="my value"
+
+# Beware of duplicates!
+SECRET=Already defined ;(
+
+# Respect the convention, use `UPPER_CASE`:
+kebab-case-name=1
+snake_case_name=2
+```
+
+And much more! You can find the [full list of violations in our docs](https://dotenv-linter.readthedocs.io/en/latest/pages/violations/).

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dotenv-linter"
-version = "0.1.0"
+version = "0.1.1"
 description = "Linting dotenv files like a charm!"
 authors = [
   "sobolevn <[email protected]>"
@@ -20,7 +20,7 @@ keywords = [
 ]
 
 classifiers = [
-  "Development Status :: 3 - Alpha",
+  "Development Status :: 4 - Beta",
   "Environment :: Console",
   "Intended Audience :: Developers",
   "Operating System :: OS Independent",