Add: README

1 files changed, 41 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b7df311
--- /dev/null
+++ b/README
@@ -0,0 +1,41 @@
+README for slog, a structured logging library for Python
+=============================================================================
+
+`slog` (structure logging) is a Python library for structured logging.
+The idea is to write logs that can be easily processed
+programmatically. The structured log files consist of JSON objects,
+encoded one per line.
+
+The library is meant for Python 3 only.
+
+
+To run tests
+-----------------------------------------------------------------------------
+
+Run the following command to run unit and integration tests:
+
+    ./check
+
+You will need [CoverageTestRunner][] and [yarn][].
+
+[CoverageTestRunner]: https://liw.fi/coverage-test-runner/
+[yarn]: https://liw.fi/cmdtest/
+
+
+Legalese
+-----------------------------------------------------------------------------
+
+Copyright 2017 Lars Wirzenius
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.