docs: copy README to docs index.md and remove QUICKSTART file (not us…

…ed anywhere)
energywebfoundation · May 20, 2022 · 3ac8fbf · 3ac8fbf
1 parent 10b7e88
commit 3ac8fbf
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 97 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,10 @@ Using `iam-client-lib`, Switchboard allows users to:
 - Define hierarchical, role-based structures for [organizations](./docs/guides/organization.md), [applications](./docs/guides/application.md) and [assets](./docs/guides/asset.md) that participate in grid activities
 - Request and issue Verifiable Credentials that are required to take on roles within an organization or application that is registered on Switchboard
 
+## Documentation
+For documentation on `iam-client-lib` modules and API: 
+- [ReadTheDocs](https://energy-web-foundation-iam-client-lib.readthedocs-hosted.com/)
+
 ## Development
 The following is for installing and building `iam-client-lib` directly. 
 For guidance on how to integrate the library into an application, see [**Getting Started**](#getting-started) below. 
@@ -135,10 +139,6 @@ const {
 const { didRegistry, claimsService } = await connectToDidRegistry();
 ```
 
-## Documentation
-For further documentation on `iam-client-lib` modules and API: 
-- [ReadTheDocs](https://energy-web-foundation-iam-client-lib.readthedocs-hosted.com/)
-
 ## Contributing Guidelines 
 Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
 

diff --git a/docs/Quick_start.md b/docs/Quick_start.md
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -21,6 +21,10 @@ Using `iam-client-lib`, Switchboard allows users to:
 - Define hierarchical, role-based structures for [organizations](./docs/guides/organization.md), [applications](./docs/guides/application.md) and [assets](./docs/guides/asset.md) that participate in grid activities
 - Request and issue Verifiable Credentials that are required to take on roles within an organization or application that is registered on Switchboard
 
+## Documentation
+For documentation on `iam-client-lib` modules and API: 
+- [ReadTheDocs](https://energy-web-foundation-iam-client-lib.readthedocs-hosted.com/)
+
 ## Development
 The following is for installing and building `iam-client-lib` directly. 
 For guidance on how to integrate the library into an application, see [**Getting Started**](#getting-started) below. 
@@ -134,10 +138,6 @@ const {
 const { didRegistry, claimsService } = await connectToDidRegistry();
 ```
 
-## Documentation
-For further documentation on `iam-client-lib` modules and API: 
-- [ReadTheDocs](https://energy-web-foundation-iam-client-lib.readthedocs-hosted.com/)
-
 ## Contributing Guidelines 
 Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
 

diff --git a/.../api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md b/.../api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md
@@ -42,7 +42,7 @@ verifiableCredentialsService.createRoleVC(...);
 
 ### continueExchange
 
-▸ **continueExchange**(`__namedParameters`): `Promise`<`undefined` \| `VpRequest` \| `VerifiablePresentation`\>
+▸ **continueExchange**(`__namedParameters`): `Promise`<`undefined` \| `VerifiablePresentation` \| `VpRequest`\>
 
 **`description`** Sends credentials requested by issuer and returns either issued credentials or next credentials request
 
@@ -54,7 +54,7 @@ verifiableCredentialsService.createRoleVC(...);
 
 #### Returns
 
-`Promise`<`undefined` \| `VpRequest` \| `VerifiablePresentation`\>
+`Promise`<`undefined` \| `VerifiablePresentation` \| `VpRequest`\>
 
 issued credentials or request of additional credentials
 

diff --git a/package.json b/package.json
@@ -150,7 +150,7 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "lint-staged && rm -rf docs/api && typedoc --plugin typedoc-plugin-markdown --hideBreadcrumbs true && git add -A docs/api/"
+      "pre-commit": "lint-staged && rm -rf docs/api && cp README.md docs/index.md && typedoc --plugin typedoc-plugin-markdown --hideBreadcrumbs true && git add -A docs/api/"
     }
   },
   "lint-staged": {