-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from fromancient/chore/package-update
Chore/package update
- Loading branch information
Showing
1 changed file
with
12 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
```markdown | ||
````markdown | ||
# polkadot-connect | ||
|
||
**polkadot-connect** is a library designed to facilitate seamless connections between your decentralized applications (DApps) and Polkadot wallets. It provides an easy-to-use interface for integrating wallet functionalities, ensuring a smooth user experience. | ||
|
@@ -14,48 +14,37 @@ | |
To install `polkadot-connect`, you can use npm or yarn: | ||
|
||
```bash | ||
npm install polkadot-connect | ||
npm install @joinerdavid0213/polkadot-connect | ||
``` | ||
```` | ||
|
||
or | ||
|
||
```bash | ||
yarn add polkadot-connect | ||
npm i @joinerdavid0213/polkadot-connect | ||
``` | ||
|
||
## Usage | ||
|
||
Here's a quick example of how to use `polkadot-connect` in your DApp: | ||
|
||
```javascript | ||
import { connectWallet } from 'polkadot-connect'; | ||
import { connectWallet } from 'polkadot-connect' | ||
|
||
async function init() { | ||
const wallet = await connectWallet(); | ||
console.log('Connected to wallet:', wallet); | ||
const wallet = await connectWallet() | ||
console.log('Connected to wallet:', wallet) | ||
} | ||
|
||
init(); | ||
init() | ||
``` | ||
|
||
## Documentation | ||
|
||
For detailed documentation and examples, please refer to the [Documentation](link-to-documentation). | ||
|
||
## Contributing | ||
|
||
We welcome contributions! If you'd like to contribute, please fork the repository and submit a pull request. For more details, check out our [Contributing Guidelines](link-to-contributing-guidelines). | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | ||
|
||
## Contact | ||
|
||
For questions or support, please open an issue on GitHub or contact us at [[email protected]]. | ||
``` | ||
For questions or support, please open an issue on GitHub or contact us at [email protected]. | ||
|
||
## Customization | ||
|
||
### Customization | ||
- Replace `link-to-documentation` and `link-to-contributing-guidelines` with actual URLs. | ||
- Update the contact email as necessary. | ||
- Feel free to add any additional sections or features relevant to your library! | ||
- Feel free to add any additional sections or features relevant to your library! |