Skip to content

Commit

Permalink
chore: updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dafuga committed Jul 27, 2024
1 parent 310e691 commit f0e67e1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
# WARNING: This is a work in progress and not ready for use.
# WARNING: This is a work in progress and not ready for production use.

# @wharfkit/account-creation-plugin-template
# @wharfkit/account-creation-plugin-metamask

A template to create a `account-creationPlugin` for use within the `@wharfkit/session` library.
Wharfkit Plugin to create EOS accounts using Metamask public key.

## Usage

- [Use this as a template.](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
- Write your account-creation plugin's logic.
- Publish it on Github or npmjs.com
- Include it in your project and use it.
[Read the Wharf account creation plugin documentation](https://wharfkit.com/docs/session-kit/plugin-account-creation)

## Developing

Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export class AccountCreationPluginMetamask

readonly metadata: AccountCreationPluginMetadata = AccountCreationPluginMetadata.from({
name: 'Account Creation Plugin Metamask',
description: 'Plugin to create EOS accounts using Metamask public key',
description: 'Plugin to create EOS accounts using Metamask public key.',
})

get id(): string {
Expand Down

0 comments on commit f0e67e1

Please sign in to comment.