Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): Update README with basic startup instructions #49

Merged
merged 10 commits into from
Aug 8, 2022

Conversation

rosspower11
Copy link
Contributor

Draft of README for did-provider-cheqd

Draft of README for did-provider-cheqd
@rosspower11 rosspower11 requested a review from Eengineer1 August 1, 2022 14:16
@rosspower11 rosspower11 changed the title Update README.md docs: Update README.md Aug 1, 2022
@rosspower11 rosspower11 changed the title docs: Update README.md docs(veramo): Update README.md Aug 1, 2022
rosspower11 and others added 9 commits August 2, 2022 15:24
commit e22818f
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Aug 8 14:01:51 2022 +0100

    chore(deps-dev): Bump @typescript-eslint/eslint-plugin from 5.31.0 to 5.32.0 (#51)

    * chore(deps-dev): Bump @typescript-eslint/eslint-plugin

    Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 5.31.0 to 5.32.0.
    - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
    - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/CHANGELOG.md)
    - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v5.32.0/packages/eslint-plugin)

    ---
    updated-dependencies:
    - dependency-name: "@typescript-eslint/eslint-plugin"
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

    * Bump version

    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Ankur Banerjee <ankurdotb@users.noreply.github.com>

commit 75b32ed
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Aug 8 13:49:21 2022 +0100

    chore(deps-dev): Bump @typescript-eslint/parser from 5.31.0 to 5.32.0 (#52)

    * chore(deps-dev): Bump @typescript-eslint/parser from 5.31.0 to 5.32.0

    Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 5.31.0 to 5.32.0.
    - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
    - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md)
    - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v5.32.0/packages/parser)

    ---
    updated-dependencies:
    - dependency-name: "@typescript-eslint/parser"
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

    * chore(deps-dev): Bump @typescript-eslint/parser from 5.31.0 to 5.32.0

    Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 5.31.0 to 5.32.0.
    - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
    - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md)
    - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v5.32.0/packages/parser)

    ---
    updated-dependencies:
    - dependency-name: "@typescript-eslint/parser"
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

    * Bump typescript-eslint/parser

    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Ankur Banerjee <ankurdotb@users.noreply.github.com>

commit 1682600
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon Aug 8 13:29:42 2022 +0100

    chore(deps-dev): Bump eslint from 8.20.0 to 8.21.0 (#53)

    * chore(deps-dev): Bump eslint from 8.20.0 to 8.21.0

    Bumps [eslint](https://github.com/eslint/eslint) from 8.20.0 to 8.21.0.
    - [Release notes](https://github.com/eslint/eslint/releases)
    - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
    - [Commits](eslint/eslint@v8.20.0...v8.21.0)

    ---
    updated-dependencies:
    - dependency-name: eslint
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

    * Squashed commit of the following:

    commit 258eb0e
    Author: semantic-release-bot <semantic-release-bot@martynus.net>
    Date:   Mon Aug 8 11:25:15 2022 +0000

        chore(release): 1.3.4 [skip ci]

        ## [1.3.4](1.3.3...1.3.4) (2022-08-08)

        ### Bug Fixes

        * **agent:** Fixed instantiation by agent & slight refactors to utilize `IDIDManager` ([bd99af5](bd99af5))

    commit bd99af5
    Author: Tasos <50984242+Eengineer1@users.noreply.github.com>
    Date:   Mon Aug 8 14:21:07 2022 +0300

        fix(agent): Fixed instantiation by agent & slight refactors to utilize `IDIDManager`

    commit ac0bdce
    Author: semantic-release-bot <semantic-release-bot@martynus.net>
    Date:   Fri Aug 5 10:43:18 2022 +0000

        chore(release): 1.3.3 [skip ci]

        ## [1.3.3](1.3.2...1.3.3) (2022-08-05)

        ### Bug Fixes

        * **deps:** Bump `@cheqd/sdk` ([0ca1cad](0ca1cad))

    * Bump eslint

    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Ankur Banerjee <ankurdotb@users.noreply.github.com>

commit 258eb0e
Author: semantic-release-bot <semantic-release-bot@martynus.net>
Date:   Mon Aug 8 11:25:15 2022 +0000

    chore(release): 1.3.4 [skip ci]

    ## [1.3.4](1.3.3...1.3.4) (2022-08-08)

    ### Bug Fixes

    * **agent:** Fixed instantiation by agent & slight refactors to utilize `IDIDManager` ([bd99af5](bd99af5))

commit bd99af5
Author: Tasos <50984242+Eengineer1@users.noreply.github.com>
Date:   Mon Aug 8 14:21:07 2022 +0300

    fix(agent): Fixed instantiation by agent & slight refactors to utilize `IDIDManager`

commit ac0bdce
Author: semantic-release-bot <semantic-release-bot@martynus.net>
Date:   Fri Aug 5 10:43:18 2022 +0000

    chore(release): 1.3.3 [skip ci]

    ## [1.3.3](1.3.2...1.3.3) (2022-08-05)

    ### Bug Fixes

    * **deps:** Bump `@cheqd/sdk` ([0ca1cad](0ca1cad))

commit 0ca1cad
Author: Tasos <50984242+Eengineer1@users.noreply.github.com>
Date:   Fri Aug 5 11:39:10 2022 +0100

    fix(deps): Bump `@cheqd/sdk`

commit d6c851b
Author: semantic-release-bot <semantic-release-bot@martynus.net>
Date:   Fri Aug 5 08:56:51 2022 +0000

    chore(release): 1.3.2 [skip ci]

    ## [1.3.2](1.3.1...1.3.2) (2022-08-05)

    ### Bug Fixes

    * **build:** Fixed schema imports ([2b3918c](2b3918c))

commit 2b3918c
Author: Tasos <50984242+Eengineer1@users.noreply.github.com>
Date:   Fri Aug 5 09:53:09 2022 +0100

    fix(build): Fixed schema imports

commit a14dab8
Author: semantic-release-bot <semantic-release-bot@martynus.net>
Date:   Thu Aug 4 23:31:45 2022 +0000

    chore(release): 1.3.1 [skip ci]

    ## [1.3.1](1.3.0...1.3.1) (2022-08-04)

    ### Bug Fixes

    * **build:** Fixed dep resolutions & file inclusion ([1f69aa6](1f69aa6))

commit 1f69aa6
Author: Tasos <50984242+Eengineer1@users.noreply.github.com>
Date:   Fri Aug 5 00:27:56 2022 +0100

    fix(build): Fixed dep resolutions & file inclusion

commit d10ee9d
Author: semantic-release-bot <semantic-release-bot@martynus.net>
Date:   Thu Aug 4 21:32:09 2022 +0000

    chore(release): 1.3.0 [skip ci]

    ## [1.3.0](1.2.0...1.3.0) (2022-08-04)

    ### Features

    * **agent:** Added cheqd raw payload agent specific create method & improvements ([7099018](7099018))

commit 7099018
Author: Tasos <50984242+Eengineer1@users.noreply.github.com>
Date:   Thu Aug 4 22:26:17 2022 +0100

    feat(agent): Added cheqd raw payload agent specific create method & improvements

commit 25988b7
Author: semantic-release-bot <semantic-release-bot@martynus.net>
Date:   Wed Aug 3 13:09:58 2022 +0000

    chore(release): 1.2.0 [skip ci]

    ## [1.2.0](1.1.1...1.2.0) (2022-08-03)

    ### Features

    * Implement cheqd plugin with custom methods for DIDDocs management ([#48](#48)) ([54855a2](54855a2))

commit 54855a2
Author: Alexander Kolesov <alexandr.kolesov@dsr-corporation.com>
Date:   Wed Aug 3 16:04:56 2022 +0300

    feat: Implement cheqd plugin with custom methods for DIDDocs management (#48)

commit 7db63de
Merge: 8b15da3 7769728
Author: Tasos Derisiotis <50984242+Eengineer1@users.noreply.github.com>
Date:   Mon Aug 1 18:54:53 2022 +0300

    Merge pull request #50 from cheqd/agent-config

    docs: Added multi-network default config

commit 7769728
Author: Tasos <50984242+Eengineer1@users.noreply.github.com>
Date:   Mon Aug 1 16:51:14 2022 +0100

    docs: Added multi-network default config

commit 8b15da3
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Thu Jul 28 20:18:23 2022 +0100

    chore(deps-dev): Bump eslint from 7.32.0 to 8.20.0 (#47)

    * chore(deps-dev): Bump eslint from 7.32.0 to 8.20.0

    Bumps [eslint](https://github.com/eslint/eslint) from 7.32.0 to 8.20.0.
    - [Release notes](https://github.com/eslint/eslint/releases)
    - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
    - [Commits](eslint/eslint@v7.32.0...v8.20.0)

    ---
    updated-dependencies:
    - dependency-name: eslint
      dependency-type: direct:development
      update-type: version-update:semver-major
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

    * Bump package.json files

    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Ankur Banerjee <ankurdotb@users.noreply.github.com>

commit 9e29745
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Thu Jul 28 20:00:07 2022 +0100

    chore(deps-dev): Bump typescript from 4.7.3 to 4.7.4 (#46)

    * chore(deps-dev): Bump typescript from 4.7.3 to 4.7.4

    Bumps [typescript](https://github.com/Microsoft/TypeScript) from 4.7.3 to 4.7.4.
    - [Release notes](https://github.com/Microsoft/TypeScript/releases)
    - [Commits](microsoft/TypeScript@v4.7.3...v4.7.4)

    ---
    updated-dependencies:
    - dependency-name: typescript
      dependency-type: direct:development
      update-type: version-update:semver-patch
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

    * Update package-lock.json

    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Ankur Banerjee <ankurdotb@users.noreply.github.com>

commit 3c6da42
Author: semantic-release-bot <semantic-release-bot@martynus.net>
Date:   Thu Jul 28 18:47:40 2022 +0000

    chore(release): 1.1.1 [skip ci]

    ## [1.1.1](1.1.0...1.1.1) (2022-07-28)

commit 61f63df
Author: Ankur Banerjee <ankurdotb@users.noreply.github.com>
Date:   Thu Jul 28 19:43:58 2022 +0100

    ci(release): Trigger NPM release

commit ff3d9e8
Author: Ankur Banerjee <ankurdotb@users.noreply.github.com>
Date:   Thu Jul 28 19:38:11 2022 +0100

    ci(release): Switch publishing to NPM Registry (#45)

    * ci: Switch to NPM Registry
    * Update .releaserc.json
    * Create dependabot.yml
    * Update package.json
    * Update workflow files
    * Update package-lock.json
    * Bump package dependencies
@ankurdotb ankurdotb changed the title docs(veramo): Update README.md docs(readme): Update README with basic startup instructions Aug 8, 2022
@ankurdotb ankurdotb merged commit 03a2496 into main Aug 8, 2022
@ankurdotb ankurdotb deleted the README-did-provider-cheqd branch August 8, 2022 14:24
@cheqd-bot
Copy link

cheqd-bot bot commented Aug 8, 2022

🎉 This PR is included in version 1.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants