1 files changed, 96 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7fabd58
--- /dev/null
+++ b/README.md
@@ -0,0 +1,96 @@
+# ponies.equestria.horse
+
+## Metadata Bits
+24bit bitsets are now used to define metadata that doesn't require a string input. A lot of reserved values remain for future use.
+
+```
+00...................... = No direct access to shared memory.
+01...................... = Partial direct access to shared memory.
+10...................... = Full direct access to shared memory.
+..0..................... = Not part of a median system.
+..1..................... = Part of a median system.
+...00................... = Not a little.
+...01................... = Age regressor.
+...10................... = Little.
+...11................... = Not a little, but younger.
+.....0.................. = Not a protector.
+.....1.................. = Protector.
+......0................. = Not a fictive.
+......1................. = Fictive.
+.......0................ = No "Not talking" attribute.
+.......1................ = "Not talking" attribute.
+........0............... = Not an host.
+........1............... = Host.
+.....................0.. = Not a robot
+.....................1.. = Robot
+.........0001........... = 1st species: Earth pony.
+.........0010........... = 1st species: Unicorn.
+.........0011........... = 1st species: Pegasus.
+.........0100........... = 1st species: Alicorn.
+.........0101........... = 1st species: Bat pony.
+.........0110........... = 1st species: Crystal pony.
+.............0001....... = 2nd species: Earth pony.
+.............0010....... = 2nd species: Unicorn.
+.............0011....... = 2nd species: Pegasus.
+.............0100....... = 2nd species: Alicorn.
+.............0101....... = 2nd species: Bat pony.
+.............0110....... = 2nd species: Crystal pony.
+```
+
+The following bits are reserved for future use or for technical reasons:
+```
+11...................... = <Reserved value(1)>
+...11................... = <Reserved value(1)>
+.........0000........... = <Reserved value(2)>
+.........0111........... = <Reserved value(2)>
+.........1000........... = <Reserved value(2)>
+.........1001........... = <Reserved value(2)>
+.........1010........... = <Reserved value(2)>
+.........1011........... = <Reserved value(2)>
+.........1100........... = <Reserved value(2)>
+.........1101........... = <Reserved value(2)>
+.........1110........... = <Reserved value(2)>
+.........1111........... = <Reserved value(2)>
+.............0000....... = <Reserved value(2)>
+.............0111....... = <Reserved value(2)>
+.............1000....... = <Reserved value(2)>
+.............1001....... = <Reserved value(2)>
+.............1010....... = <Reserved value(2)>
+.............1011....... = <Reserved value(2)>
+.............1100....... = <Reserved value(2)>
+.............1101....... = <Reserved value(2)>
+.............1110....... = <Reserved value(2)>
+.............1111....... = <Reserved value(2)>
+.................0000... = <Reserved value(3)>
+.................0001... = <Reserved value(3)>
+.................0010... = <Reserved value(3)>
+.................0011... = <Reserved value(3)>
+.................0100... = <Reserved value(3)>
+.................0101... = <Reserved value(3)>
+.................0110... = <Reserved value(3)>
+.................0111... = <Reserved value(3)>
+.................1000... = <Reserved value(3)>
+.................1001... = <Reserved value(3)>
+.................1010... = <Reserved value(3)>
+.................1011... = <Reserved value(3)>
+.................1100... = <Reserved value(3)>
+.................1101... = <Reserved value(3)>
+.................1110... = <Reserved value(3)>
+.................1111... = <Reserved value(3)>
+......................00 = <Reserved value(4)>
+......................01 = <Reserved value(4)>
+......................10 = <Reserved value(4)>
+......................11 = <Reserved value(4)>
+......................00 = <Reserved value(4)>
+......................01 = <Reserved value(4)>
+......................10 = <Reserved value(4)>
+......................11 = <Reserved value(4)>
+```
+
+`(1)` Reserved for additional value state<br>
+`(2)` Reserved for additional supported species<br>
+`(3)` Reserved for an additional species entry<br>
+`(4)` Reserved for additional metadata
+
+The minimum value of the bitset is 0 and the maximum value 16777215.
+For example, for Scoots, the value would be `100010101010000110000000` (9085312)
+\ No newline at end of file