-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jobin Ayathil
authored and
Jobin Ayathil
committed
Oct 24, 2023
1 parent
8f89805
commit 133bace
Showing
4 changed files
with
723 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,37 @@ | ||
|
||
# Obscuro Gateway Widget | ||
|
||
This package provides an easy-to-integrate widget for the Obscuro Gateway. Once included in a webpage, the widget allows users to interact with the Obscuro network. | ||
|
||
## Installation | ||
|
||
To install the Obscuro Gateway Widget, use npm: | ||
|
||
```bash | ||
npm install obscuro-widget | ||
``` | ||
|
||
## Usage | ||
|
||
To use the Obscuro Gateway Widget in your webpage: | ||
|
||
1. Include the widget's JavaScript in your HTML file: | ||
|
||
```html | ||
<script src="path_to_node_modules/obscuro-widgetsrc/index.js"></script> | ||
``` | ||
|
||
Once the script is included, the Obscuro Gateway Widget will automatically be embedded in your webpage. | ||
|
||
## Configuration | ||
|
||
Currently, the widget does not accept any external configuration. It's designed to work out-of-the-box once embedded. | ||
|
||
## License | ||
|
||
Include your license information here or refer to the LICENSE file in the package. | ||
|
||
--- | ||
|
||
For more details or to contribute to this package, please visit the [GitHub repository](https://github.com/YourUsername/YourRepositoryName.git). | ||
|
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 |
---|---|---|
@@ -0,0 +1,23 @@ | ||
{ | ||
"name": "obscuro-widget", | ||
"version": "1.0.0", | ||
"description": "Obscuro widget that enables developers to embed a widget that makes it easy for users to connect with the Obscuro gateway.", | ||
"main": "src/index.js", | ||
"keywords": [ | ||
"obscuro", | ||
"gateway", | ||
"widget", | ||
"ethereum", | ||
"blockchain", | ||
"web3", | ||
"metamask" | ||
], | ||
"author": "obscuro", | ||
"license": "ISC", | ||
"dependencies": { | ||
"ethers": "latest" | ||
}, | ||
"devDependencies": { | ||
"parcel": "^2.10.0" | ||
} | ||
} |
Oops, something went wrong.