📝 Update Readme

itmisx · Dec 10, 2021 · fa3d8f5 · fa3d8f5
1 parent 322a1e8
commit fa3d8f5
Showing 1 changed file with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,18 @@
 # crc
-crc of golang
+
+crc 校验在物联网数据校验中经常使用，这里封装了crc8和crc16的计算方法。
+
+#### install
+
+`go get -u https://github.com/itmisx/crc`
+
+#### example
+
+````go
+// crc8
+var data = []byte{0x01,0x02}
+crc8 := crc.Crc8(data)
+// crc16
+var data = []byte{0x01,0x02}
+crc16 := crc.Crc16(data)
+````