Fixed dependencies and updated readme

Cargo.toml

@@ -12,7 +12,7 @@ readme = "README.md"
 crate-type = ["lib", "cdylib"]
 
 [dependencies]
-memflow-core = { path = "../memflow/memflow-core" }
+memflow-core = { path = "../memflow/memflow-core", features = ["plugins"] }
 memflow-derive = { path = "../memflow/memflow-derive" }
 log = { version = "0.4.8", default-features = false }
 rusb = "0.6.0"

README.md

@@ -0,0 +1,39 @@
+# memflow-pcileech
+
+This connector implements a rust-native implementation of the pcileech interface.
+
+More information about pcileech can be found under https://github.com/ufrisk/pcileech.
+
+
+## Compilation
+#
+
+This project uses libusb to interface with the ftdi chip over usb. Make sure you have the appropiate headers installed. More information about the libusb implementation can be found in the https://github.com/a1ien/rusb project.
+
+### Using the library in a rust project
+
+To use the plugin in a rust project just include it in your Cargo.toml
+
+```
+memflow-pcileech = "0.1"
+```
+
+Make sure to not enable the `plugin` feature when importing multiple
+connectors in a rust project without using the memflow plugin inventory.
+This might cause duplicated exports being generated in your project.
+
+### Building the stand-alone plugin
+
+The stand-alone plugin of this library is feature-gated behind the `plugin` feature.
+To compile a dynamic library as a plugin use the following command:
+
+```cargo build --release --all-features```
+
+## License
+#
+
+Licensed under MIT License, see [LICENSE](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.