updates readme. adds license.

cbergoon · Jan 26, 2019 · 2353d59 · 2353d59
1 parent 894ecea
commit 2353d59
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Cameron Bergoon
+
+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
@@ -18,6 +18,10 @@ defined. For now Pipes is an experimental library.
 * Customizable state changed handler.
 * Process level error reporting.
 * FUTURE: External plugin system for process blocks running as their own process in any language.
+* FUTURE: Built-in database processes.
+
+NEW: A definition language for pipes called [pipes-dl](github.com/cbergoon/pipes-dl) is also available. This provides a simple
+DSL that can be used to define a pipeline.
 
 #### Installation
 
@@ -35,7 +39,23 @@ import "github.com/cbergoon/pipes"
 
 #### Documentation
 
+A Pipes pipeline consists of two main concepts: processes and connections. As you might have guessed a processes are
+are linked and communicate via connections to form a pipeline. These connections also define the process graph which
+define the flow of messages and execution through the pipeline.
+
+##### Processes
+
+###### JSON File Process
+
+###### HTTP Process
+
+###### DynamicJs Process
 
+##### Connections
+
+##### Pipelines
+
+##### JSON Pipeline Definition
 
 #### Example Usage
 
@@ -49,3 +69,10 @@ import "github.com/cbergoon/pipes"
     }
 ```
 
+#### Contributions
+
+All contributions are welcome.
+
+#### License
+
+This project is licensed under the MIT License.