Adding information.

Cargo.toml

@@ -3,6 +3,13 @@ name = "erc20"
 version = "0.1.0"
 authors = ["Rodolfo Araujo <[email protected]>"]
 edition = "2018"
+license = "MIT"
+description = "A simple implementation for parsing ERC20 transactions from the blockchain"
+repository = "https://github.com/rodoufu/erc20"
+readme = "README.md"
+keywords = ["blockchain", "ethereum", "transaction", "transfer", "web3"]
+categories = ["blockchain", "ethereum"]
+
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

README.md

@@ -2,5 +2,47 @@
 
 ## Rust ERC20 parser
 
-This project intends to parse the Ethereum transactions from web3 into an abstration that makes generic dealing 
+This project intends to parse the Ethereum transactions from web3 into an abstraction that makes generic dealing 
 with Ethereum or ERC20 transfers.
+
+## Code examples
+
+### Parsing a transfer
+
+```rust
+let serialized_str = "a9059cbb0000000000000000000000006748f50f686bfbca6fe8ad62b22228b87f31ff2b00000000000000000000000000000000000000000000003635c9adc5dea00000";
+
+let transaction = Transaction {
+    hash: string_to_h256("43a5d6d13b6a9dca381e3f4b4677a4b9e5d9f80d1a5b6cfa2b1404fab733bcee".to_string()).unwrap(),
+    nonce: Default::default(),
+    block_hash: None,
+    block_number: None,
+    transaction_index: None,
+    from: H160::random(),
+    to: Some(H160::random()),
+    value: Default::default(),
+    gas_price: Default::default(),
+    gas: Default::default(),
+    input: Bytes(hex::decode(serialized_str).unwrap()),
+    raw: None,
+};
+
+let resp: Result<TransactionAndTransferType, ERC20Error> = transaction.clone().try_into();
+```
+
+### Identifying an ERC20 contract address
+
+```rust
+let tusd_address = H160::from_str("0000000000085d4780B73119b644AE5ecd22b376").unwrap();
+assert_eq!("0x0000000000085d4780B73119b644AE5ecd22b376".to_string(), format!("{:?}", tusd_address));
+
+let contract_address: ContractAddress = tusd_address.into();
+assert_eq!(ContractAddress::TUSD, contract_address);
+
+let tusd_from_contract: H160 = contract_address.into();
+assert_eq!(tusd_address, tusd_from_contract);
+```
+
+## References
+
+- https://eips.ethereum.org/EIPS/eip-20