summaryrefslogtreecommitdiff
path: root/readme.rst
diff options
context:
space:
mode:
authorPhilipp Gesang <phg@phi-gamma.net>2018-10-27 23:06:35 +0200
committerPhilipp Gesang <phg@phi-gamma.net>2018-10-30 01:15:03 +0100
commit1702e79c17b4fa05159afd503f3dcd631c1a86d0 (patch)
tree7f7a1e962c6ad7ec7e19b5c9d4e91267f9411991 /readme.rst
parent8d1269767de9268db630187fc9da9b58c49a0745 (diff)
downloadocaml-sid-1702e79c17b4fa05159afd503f3dcd631c1a86d0.tar.gz
add readme and license text
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000..4a95f48
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,19 @@
+synopsis
+--------
+Library routines for handling Microsoft Security Identifiers in text and binary
+format.
+
+Includes a utility ``sidparse`` for dissecting SIDs on the command line.
+
+references
+----------
+SIDs are specified in MS-DTYP_.
+
+.. _MS-DTYP: https://msdn.microsoft.com/en-us/library/cc230273.aspx
+
+license
+-------
+This package is licensed_ as ``LGPL-3.0-only`` (no “any later version” clause).
+
+.. _licensed: https://spdx.org/licenses/LGPL-3.0-only.html
+