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

Add Obscuro Gateway Widget Package in Tools #1620

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions tools/gatewaywidget/README.md
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).

23 changes: 23 additions & 0 deletions tools/gatewaywidget/package.json
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"
}
}
Loading