MIT license

discretelogics · Mar 17, 2019 · ebc8b1d · ebc8b1d
1 parent 938e3fd
commit ebc8b1d
Show file tree

Hide file tree

Showing 3 changed files with 108 additions and 88 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2012-present Thomas Hulka
+
+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/License.txt b/License.txt
diff --git a/README.md b/README.md
@@ -1,82 +1,87 @@
-TeaFiles.Net - Time Series Storage in Files
-===========================================
-
-Use TeaFiles.Net to create, read and write files holding time series data.
-
-
-
-Features
---------
-
-* highest **performance**
-* very **simple**
-* **versatile** - open TeaFiles with C++, C#, Python, R, on any platform
-
-
-
-TeaFiles = Binary Data + Header
--------------------------------
-
-* TeaFile is a **file format**
-* to store **time series**
-* as binary **flat files**
-* optional **header** holds a **description** of file contents (metadata)
-* including a description of the **item type layout** (schema)
-* simple format, designed to make API writing very easy
-* http://www.discretelogics.com published the file format and
-* releases APIs for C#, C++, Python under the GPL
-
-
-
-Performance
------------
-> 250 Mio Items per seconds cold  
-> 465 Mio Items per seconds warm
-
-benchmark results at http://www.discretelogics.com/resources/benchmarks/teafilesbm.htm
-
-
-
-Installation
-------------
-
-* Get the NuGet package from nuget.org/packages/TeaFiles.Net or  
-
-
-Documentation
--------------
-
-The API class documentation is available online at www.discretelogics.com/doc/teafiles.net
-
-TeaTime product family
-----------------------
-
-TeaFiles are the foundation of the TeaTime product family, the toolset for persistence, visualisation and real time analysis of time series.
-
-Related products: 
-* [TeaShell](http://www.discretelogics.com/teashell) - Browse Time Series like Photos
-
-Examples
---------
-
-```C#
-// define time series item type
-struct Tick
-{
-    public Time Time;
-    public double Price;
-    public int Volume;
-}
- // create file and write values
-using (var tf = TeaFile<Tick>.Create("acme.tea"))
-{
-    tf.Write(new Tick { Price = 5, Time = DateTime.Now, Volume = 700 });
-    tf.Write(new Tick { Price = 15, Time = DateTime.Now.AddHours(1), Volume = 1700 });
-    // ...
-}
-// sum the prices of all items in the file
-using (var tf = TeaFile<Tick>.OpenRead("acme.tea"))
-{
-    return tf.Items.Sum(item => item.Price);
-}
-```
+TeaFiles.Net - Time Series Storage in Files
+===========================================
+
+Use TeaFiles.Net to create, read and write files holding time series data.
+
+
+
+Features
+--------
+
+* highest **performance**
+* very **simple**
+* **versatile** - open TeaFiles with C++, C#, Python, R, on any platform
+
+
+
+TeaFiles = Binary Data + Header
+-------------------------------
+
+* TeaFile is a **file format**
+* to store **time series**
+* as binary **flat files**
+* optional **header** holds a **description** of file contents (metadata)
+* including a description of the **item type layout** (schema)
+* simple format, designed to make API writing very easy
+* http://www.discretelogics.com published the file format and
+* releases APIs for C#, C++, Python under the GPL
+
+
+
+Performance
+-----------
+> 250 Mio Items per seconds cold  
+> 465 Mio Items per seconds warm
+
+benchmark results at http://www.discretelogics.com/resources/benchmarks/teafilesbm.htm
+
+
+
+Installation
+------------
+
+* Get the NuGet package from nuget.org/packages/TeaFiles.Net or  
+
+
+Documentation
+-------------
+
+The API class documentation is available online at www.discretelogics.com/doc/teafiles.net
+
+TeaTime product family
+----------------------
+
+TeaFiles are the foundation of the TeaTime product family, the toolset for persistence, visualisation and real time analysis of time series.
+
+Related products: 
+* [TeaShell](http://www.discretelogics.com/teashell) - Browse Time Series like Photos
+
+Examples
+--------
+
+```C#
+// define time series item type
+struct Tick
+{
+    public Time Time;
+    public double Price;
+    public int Volume;
+}
+ // create file and write values
+using (var tf = TeaFile<Tick>.Create("acme.tea"))
+{
+    tf.Write(new Tick { Price = 5, Time = DateTime.Now, Volume = 700 });
+    tf.Write(new Tick { Price = 15, Time = DateTime.Now.AddHours(1), Volume = 1700 });
+    // ...
+}
+// sum the prices of all items in the file
+using (var tf = TeaFile<Tick>.OpenRead("acme.tea"))
+{
+    return tf.Items.Sum(item => item.Price);
+}
+```
+
+License
+-------
+
+Released under the MIT license.