From 352bbd8e8d0b96b4c417bcf589003765ddef0755 Mon Sep 17 00:00:00 2001
From: derpy-duck <115193320+derpy-duck@users.noreply.github.com>
Date: Mon, 14 Aug 2023 10:26:15 -0400
Subject: [PATCH] add urls

---
 README.md | 29 +++++++++++++----------------
 1 file changed, 13 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 73cb384..1175672 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,30 @@
 # Wormhole Solidity SDK
 
-The purpose of this SDK is to provide helpers to take your existing single-chain solidity application cross-chain
+The purpose of this SDK is to provide helpers to take your existing single-chain solidity application cross-chain using Wormhole's automatic relayers
 
 ### Installation
 
 **Foundry and Forge**
+
 ```bash
 forge install wormhole-foundation/wormhole-solidity-sdk
 ```
 
-### Example Usage
+### Example Usage + Introduction to Automatic Relayers
 
-[HelloWormhole - Simple cross-chain message sending application](https://github.com/JoeHowarth/hello-wormhole)
+[HelloWormhole - Simple cross-chain message sending application](https://github.com/wormhole-foundation/hello-wormhole)
 
-[HelloToken - Simple cross-chain token sending application](https://github.com/JoeHowarth/hello-tokens)
+[HelloToken - Simple cross-chain token sending application](https://github.com/wormhole-foundation/hello-token)
 
 ### SDK Summary
 
-- Includes interfaces to interact with contracts in the Wormhole ecosystem (src/interfaces)
+- Includes interfaces to interact with contracts in the Wormhole ecosystem ([src/interfaces](https://github.com/wormhole-foundation/wormhole-solidity-sdk/tree/main/src/interfaces))
 - Includes the base class ‘Base’ with helpers for common actions that will typically need to be done within ‘receiveWormholeMessages’:
-    - `onlyWormholeRelayer()`: Checking that msg.sender is the wormhole relayer contract
-    - `replayProtect(bytes32 deliveryHash)`: Checking that the current delivery has not already been processed (via the hash)
-    
+  - [`onlyWormholeRelayer()`](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/src/WormholeRelayerSDK.sol#L26): Checking that msg.sender is the wormhole relayer contract
+  - [`replayProtect(bytes32 deliveryHash)`](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/src/WormholeRelayerSDK.sol#L31): Checking that the current delivery has not already been processed (via the hash)
     Sometimes, Cross-chain applications may be set up such that there is one ‘spoke’ contract on every chain, which sends messages to the ‘hub’ contract. If so, we’d ideally only want to allow messages to be sent from these spoke contracts. Included are helpers for this:
-    
-    - `setRegisteredSender(uint16 sourceChain, bytes32 sourceAddress)`: Setting the specified sender for ‘sourceChain’ to be ‘sourceAddress’
-    - `isRegisteredSender(uint16 sourceChain, bytes32 sourceAddress)` : Checking that the sender who requested the delivery is the registered address for that chain
-    
-    Look at test/Counter.t.sol for an example usage of Base
-    
-- Included are also the ‘TokenSender’ and ‘TokenReceiver’ base classes with helpers for smart contracts that wish to send and receive tokens using Wormhole’s TokenBridge. See ‘HelloToken’ for example usage.
-- Included are helpers that help set up a local forge testing environment. See ‘HelloWormhole’ for example usage.
+  - [`setRegisteredSender(uint16 sourceChain, bytes32 sourceAddress)`](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/src/WormholeRelayerSDK.sol#L49): Setting the specified sender for ‘sourceChain’ to be ‘sourceAddress’
+  - [`isRegisteredSender(uint16 sourceChain, bytes32 sourceAddress)`](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/src/WormholeRelayerSDK.sol#L37): Checking that the sender who requested the delivery is the registered address for that chain
+    Look at [test/Fork.t.sol](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/test/Fork.t.sol#L16) for an example usage of Base
+- Included are also the ‘[TokenSender](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/src/WormholeRelayerSDK.sol#L79)’ and ‘[TokenReceiver](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/src/WormholeRelayerSDK.sol#L186)’ base classes with helpers for smart contracts that wish to send and receive tokens using Wormhole’s TokenBridge. See ‘[HelloToken](https://github.com/wormhole-foundation/hello-token)’ for example usage.
+- Included are helpers that help set up a local forge testing environment. See ‘[HelloWormhole](https://github.com/wormhole-foundation/hello-wormhole)’ for example usage.