From 2a00738f0d9e4761fed7b23eb84c971b71f7c452 Mon Sep 17 00:00:00 2001
From: Dominik 'Rathann' Mierzejewski <dominik@greysector.net>
Date: Aug 07 2020 09:40:59 +0000
Subject: put project description in README.md


---

diff --git a/README.md b/README.md
index 259c3a4..c0a2a55 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
 # python-gsd
 
-The python-gsd package
\ No newline at end of file
+GSD (General Simulation Data) is a file format specification and a library
+to read and write it. The package also contains a python module that reads
+and writes hoomd schema gsd files with an easy to use syntax.
+
+* Efficiently store many frames of data from simulation runs.
+* High performance file read and write.
+* Support arbitrary chunks of data in each frame (position, orientation,
+  type, etc...).
+* Append frames to an existing file with a monotonically increasing frame
+  number.
+* Resilient to job kills.
+* Variable number of named chunks in each frame.
+* Variable size of chunks in each frame.
+* Each chunk identifies data type.
+* Common use cases: NxM arrays in double, float, int, char types.
+* Generic use case: binary blob of N bytes.
+* Easy to integrate into other tools with python, or a C API (< 1k lines).
+* Fast random access to frames.