The v1.0.0 README.md file is largely incompatible with the interceptors branch rewrite. Much of the API has been intentionally changed, including revisions and removals. v2.0.0 will require a new README with the correct API and documentation.
Proposed solution
A new README file should be created with the v2.0.0 API and relevant documentation.
Additional considerations
Inline XML documentation should also be added to the generated source files, though this is not required for the v2.0.0 milestone. API documentation may also be moved to a separate GitHub wiki, rather than keeping it in the README.
Describe the issue
The v1.0.0
README.md
file is largely incompatible with theinterceptors
branch rewrite. Much of the API has been intentionally changed, including revisions and removals. v2.0.0 will require a new README with the correct API and documentation.Proposed solution
A new README file should be created with the v2.0.0 API and relevant documentation.
Additional considerations
Inline XML documentation should also be added to the generated source files, though this is not required for the v2.0.0 milestone. API documentation may also be moved to a separate GitHub wiki, rather than keeping it in the README.