Update README (#8)

* Update README and add license

* Update README

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 ScopeLift
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,14 +1,75 @@
 # ERC-5564 and ERC-6538 Contracts
 
 This repo contains the canonical implementations of the ERC-5564 and ERC-6538 contracts:
+
 - [ERC-5564](https://eips.ethereum.org/EIPS/eip-5564) Stealth Addresses: Private, non-interactive transfers and interactions.
 - [ERC-6538](https://eips.ethereum.org/EIPS/eip-6538) Stealth Meta-Address Registry: A registry to map addresses to stealth meta-addresses
 
-## Development
+## Usage
 
 This repo is developed using [Foundry](https://book.getfoundry.sh/).
 
+### Setup
+
+1. Install Foundry on your local machine by following the [instructions here](https://book.getfoundry.sh/getting-started/installation).
+
+2. Clone the repo and navigate to the root directory of the repo:
+
+```sh
+git clone [email protected]:ScopeLift/stealth-address-erc-contracts.git
+cd stealth-address-erc-contracts
+```
+
+### Compile
+
+```sh
+# Build the contracts
+forge build
+```
+
+### Test
+
 ```sh
 # Run the tests
 forge test
 ```
+
+### Coverage
+
+```sh
+# See test coverage
+forge coverage
+```
+
+### Linting and Specifications
+
+This project uses [scopelint](https://github.com/ScopeLift/scopelint) for linting and spec generation. Follow [these instructions](https://github.com/ScopeLift/scopelint?tab=readme-ov-file#installation) to install it.
+
+#### Lint
+
+```bash
+# Check formatting
+scopelint check
+# Apply formatting changes
+scopelint fmt
+```
+
+#### Spec
+
+```bash
+scopelint spec
+```
+
+This command will use the names of the contract's unit tests to generate a human readable spec. It will list each contract, its constituent functions, and the human readable description of functionality each unit test aims to assert.
+
+## Deployments
+
+Coming soon.
+
+## Security
+
+Coming soon.
+
+## License
+
+Contracts in this repository are released under the [MIT License](https://github.com/ScopeLift/stealth-address-erc-contracts/blob/main/LICENSE).