move package-specific readme text to package-specific readmes

Author: ItsNickBarry

README.md

@@ -25,63 +25,6 @@ It consists of the following packages:
 | `@solidstate/library`   | functions for interacting with and validating contracts                               | [📖](./lib/README.md)       |
 | `@solidstate/spec`      | portable tests which may be run against third-party implementations of core contracts | [📖](./spec/README.md)      |
 
-### Contracts
-
-All contracts are designed to either be deployed through the standard `constructor` method, or referenced by a proxy. To this end, the [diamond storage](https://medium.com/1milliondevs/new-storage-layout-for-proxy-contracts-and-diamonds-98d01d0eadb) pattern is employed exclusively.
-
-### Spec
-
-Where possible, automated tests are designed to be imported by repositories which make use of the Solidstate contracts and run against any derived contracts. This is to help prevent unintended changes to the base contract behavior.
-
-For example, consider a custom `ERC20Base` implementation:
-
-```solidity
-import '@solidstate/contracts/token/ERC20/base/ERC20Base.sol';
-
-contract CustomToken is ERC20Base {
-  // custom code...
-}
-```
-
-Rather than rewrite the `ERC20Base` tests or assume that all core behavior remains untouched, one can import the included tests and run them against the custom implementation:
-
-```javascript
-describe('CustomToken', () => {
-  let instance;
-
-  beforeEach(async () => {
-    const factory = await ethers.getContractFactory('CustomToken');
-    instance = await factory.deploy();
-    await instance.deployed();
-  });
-
-  describeBehaviorOfERC20Base(
-    async () => instance,
-    {
-      args: ...,
-    }
-  );
-
-  // custom tests...
-});
-```
-
-If parts of the base implementation are changed intentionally, tests can be selectively skipped:
-
-```javascript
-describeBehaviorOfERC20Base(
-  async () => instance,
-  {
-    args: ...
-  },
-  ['#balanceOf'],
-);
-
-describe('#balanceOf', () => {
-  // custom tests
-});
-```
-
 ## Development
 
 Install dependencies via Yarn:

contracts/README.md

@@ -16,6 +16,8 @@ yarn add --dev @solidstate/contracts
 
 ## Code Structure
 
+All contracts are designed to either be deployed through the standard `constructor` method, or referenced by a proxy. To this end, the [diamond storage](https://medium.com/1milliondevs/new-storage-layout-for-proxy-contracts-and-diamonds-98d01d0eadb) pattern is employed exclusively.
+
 ### Layers Pattern
 
 Each of the Solidstate contracts is split into multiple "layers" across multiple files: external contracts, internal contracts, external interfaces, internal interfaces, and storage libraries.

spec/README.md

@@ -11,3 +11,56 @@ npm install --save-dev @solidstate/spec
 # or
 yarn add --dev @solidstate/spec
 ```
+
+## Usage
+
+Where possible, automated tests are designed to be imported by repositories which make use of the Solidstate contracts and run against any derived contracts. This is to help prevent unintended changes to the base contract behavior.
+
+For example, consider a custom `ERC20Base` implementation:
+
+```solidity
+import '@solidstate/contracts/token/ERC20/base/ERC20Base.sol';
+
+contract CustomToken is ERC20Base {
+  // custom code...
+}
+```
+
+Rather than rewrite the `ERC20Base` tests or assume that all core behavior remains untouched, one can import the included tests and run them against the custom implementation:
+
+```javascript
+describe('CustomToken', () => {
+  let instance;
+
+  beforeEach(async () => {
+    const factory = await ethers.getContractFactory('CustomToken');
+    instance = await factory.deploy();
+    await instance.deployed();
+  });
+
+  describeBehaviorOfERC20Base(
+    async () => instance,
+    {
+      args: ...,
+    }
+  );
+
+  // custom tests...
+});
+```
+
+If parts of the base implementation are changed intentionally, tests can be selectively skipped:
+
+```javascript
+describeBehaviorOfERC20Base(
+  async () => instance,
+  {
+    args: ...
+  },
+  ['#balanceOf'],
+);
+
+describe('#balanceOf', () => {
+  // custom tests
+});
+```