Adds README.md for core library

README.md

@@ -21,6 +21,6 @@ For ease of use you should use both the [Gradle Plugin](gradle-plugin) and the [
 
 The project is separated into 3 different projects:
 
-- **core:** The actual code that makes the magic
+- **core:** The actual code that makes the magic [Core library](core)
 - **gradle-plugin:** Gradle plugin to use Chamaleon [Gradle Plugin](gradle-plugin)
 - **intellij-plugin:** Intellij plugin to switch between the different environments [Intellij Plugin]()

core/README.md

@@ -0,0 +1,18 @@
+# Chamaleon Core
+
+Library that parses the `cha` files and returns the set of environments.
+It's consumed by the [Gradle plugin](../gradle-plugin) and the [Intellij Plugin]()
+
+## How it works?
+
+Just create an EnvironmentsProcessor, and it will parse the directory provided and give you the environments if present
+
+````kotlin
+val file = File("MyDirectory")
+
+val environmentsProcessor = EnvironmentsProcessor(file)
+
+val environments = environmentsProcessor.environments()
+
+val someEnvironment = environments.first()
+````