Develop

.eslintignore

@@ -4,3 +4,4 @@ scripts/*
 sandbox.ts
 test_utils/*
 examples/*
+webpack.*

.eslintrc.js

@@ -21,9 +21,13 @@ module.exports = {
     // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
     // e.g. "@typescript-eslint/explicit-function-return-type": "off",
     '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-namespace': 'off',
+    '@typescript-eslint/no-empty-interface': 'off',
+    "import/prefer-default-export": 'off',
     'jest/expect-expect': 'error',
     'jest/no-empty-title': 'warn',
     'jest/no-truthy-falsy': 'warn',
+    'import/prefer-default-export': 'off',
   },
   settings: {
     'import/resolver': {

README.md

@@ -1,6 +1,6 @@
 ## @polymathnetwork/contract-wrappers
 
-Version 2.1.0 of the Polymath-Core contracts
+Version 3.0.0 of the Polymath-Core Ethereum Smart Contracts
 
 Smart TS wrappers for Polymath smart contracts.
 
@@ -26,6 +26,11 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol
 }
 ```
 
+## Documentation
+This project uses typedoc documentation style.
+
+You can access these docs by cloning this repo and opening `docs/index.html` in the browser.
+
 ## Contributing
 
 We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
@@ -215,3 +220,12 @@ const params: ApiConstructorParams = {
 };
 const polymathAPI = new PolymathAPI(params);
 ```
+
+### Module code examples
+In the `/examples` directory there are several examples to help developers understand how to use the API within the sandbox.
+
+These examples demonstrate the use of the project's PolymathAPI to get data and publish transactions with Polymath's smart contracts. Register a ticker, generate a new security token and then you can add a module.
+
+When a security token has a module successfully attached, the examples demonstrate how one can work with sto creation, transfer restrictions, permissioning, and directly with the security token. 
+
+The sandbox code included in the examples demonstrates how to subscribe to events fired from the smart contracts. It also demonstrates how to better catch issues when they happen, during token transfers for instance.