update readme, license, Cargo.toml

3 files changed, 37 insertions, 16 deletions

diff --git a/Cargo.toml b/Cargo.toml
index 3436931..9e089d2 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -4,13 +4,13 @@ name = "yaxpeax-arch"
 version = "0.0.1"
 authors = [ "iximeow <me@iximeow.net>" ]
 license = "0BSD"
-repository = "yaxpeax-arch"
+repository = "https://git.iximeow.net/yaxpeax-arch/"
 description = "fundamental traits to describe an architecture in the yaxpeax project"
 
 [dependencies]
 "num-traits" = "0.2"
 "termion" = "1.4.0"
-"serde" = "*"
+"serde" = "1.0"
 
 [profile.release]
 lto = true
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..7091f53
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,12 @@
+Copyright (c) 2020 iximeow
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
diff --git a/README.md b/README.md
index 6f8751a..f2202f9 100644
--- a/README.md
+++ b/README.md
@@ -8,21 +8,30 @@ there are numerous architectures for which decoders are implemented, at varying
 
 | symbol | meaning |
 | ------ | ------- |
-| + | complete, reliable |
-| ? | "complete", likely has gaps |
-| ~ | incomplete |
-| - | unimplemented |
+| 🥳 | complete, reliable |
+| ⚠️| "complete", likely has gaps |
+| 🚧 | incomplete |
+| ❓ | unimplemented |
 
 
 | architecture | library | decode | tests | benchmarks | note |
 | ------------ | ------- | ------ | ----- | ---------- | ---- |
-| `x86_64` | yaxpeax-x86 | ? | ~ | ~ | incomplete operand decoding, may incorrectly accept long instructions |
-| `x86:32` | yaxpeax-x86 | - | - | - | should share most but not all implementation with `x86_64` |
-| `x86:16` | yaxpeax-x86 | - | - | - | should share most but not all implementation with `x86:32` |
-| `armv7` | yaxpeax-arm | ~ | ~ | - | |
-| `armv8` | yaxpeax-arm | ~ | ~ | - | |
-| `mips` | yaxpeax-mips | ~ | ~ | - | |
-| `msp430` | yaxpeax-msp430 | ~ | ~ | - | |
-| `pic17` | yaxpeax-pic17 | ~ | ~ | - | |
-| `pic18` | yaxpeax-pic18 | ~ | ~ | - | |
-| `pic24` | yaxpeax-pic24 | - | - | - | exists, but only decodes `NOP` |
+| `x86_64` | yaxpeax-x86 | ⚠️| 🚧 | 🚧 | incomplete operand decoding, may incorrectly accept long instructions |
+| `x86:32` | yaxpeax-x86 | ❓ | ❓ | ❓ | should share most but not all implementation with `x86_64` |
+| `x86:16` | yaxpeax-x86 | ❓ | ❓ | ❓ | should share most but not all implementation with `x86:32` |
+| `armv7` | yaxpeax-arm | 🚧 | 🚧 | ❓ | |
+| `armv8` | yaxpeax-arm | 🚧 | 🚧 | ❓ | |
+| `mips` | yaxpeax-mips | 🚧 | 🚧 | ❓ | |
+| `msp430` | yaxpeax-msp430 | 🚧 | 🚧 | ❓ | |
+| `pic17` | yaxpeax-pic17 | 🚧 | 🚧 | ❓ | |
+| `pic18` | yaxpeax-pic18 | 🚧 | 🚧 | ❓ | |
+| `pic24` | yaxpeax-pic24 | ❓ | ❓ | ❓ | exists, but only decodes `NOP` |
+
+### mirrors
+
+the canonical copy of `yaxpeax-arch` is at [https://git.iximeow.net/yaxpeax-arch](https://git.iximeow.net/yaxpeax-arch).
+
+`yaxpeax-arch` is also mirrored on GitHub at [https://www.github.com/iximeow/yaxpeax-x86](https://www.github.com/iximeow/yaxpeax-arch).
+
+### ! user beware !
+these interfaces will almost certainly move and change. the version number is `0.0.1` and i mean it with every fiber of my being.