https://github.com/amorriscode/stx-me

A hassle-free way to accept STX from any website.
https://github.com/amorriscode/stx-me

bitcoin blockchain blockstack hacktoberfest stacks stx

Last synced: about 1 month ago
JSON representation

A hassle-free way to accept STX from any website.

• Host: GitHub
• URL: https://github.com/amorriscode/stx-me
• Owner: amorriscode
• Created: 2021-03-23T20:36:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-03T00:33:37.000Z (about 3 years ago)
• Last Synced: 2024-09-16T23:34:56.909Z (2 months ago)
• Topics: bitcoin, blockchain, blockstack, hacktoberfest, stacks, stx
• Language: TypeScript
• Homepage: https://getstx.me
• Size: 504 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# stx.me

Creators all over the web have been using services like [Buy Me a Coffee](https://www.buymeacoffee.com/) to easily accept donations from their supports. What if creators could easily accept STX donations? That's exactly what stx.me aims to achieve!

Accept STX donations from any website by simply adding a ``.

## Getting Started

1. Add the stx.me container to your webpage

```html

<div id="stx-me"></div>

```

2. Add the stx.me script to your webpage

```html

<script src="https://unpkg.com/stx-me/dist/stx.me.js">

```

3. Initialize stx.me with your wallet address

```html

    stx.me('SP2D71SFBCAX1VE664GKQP2Y7YMRDW6YJGVQVXB1T');

```

4. Add stx.me stylesheet (optional)

```html

```

## Configuration

The stx.me function takes a second, optional parameter of options. The following options are allowed:

```typescript

interface AppDetails {

  name: string;

  icon: string;

}

interface ConfigOptions {

  showAddress?: boolean;

  appDetails?: AppDetails;

  successMessage?: string;

  buttonText?: string;

  network?: string;

}

```

### AppDetails

Used to configure what users will see witihin the Stacks wallet.

| Parameter | Default        | Description                                          |

| --------- | -------------- | ---------------------------------------------------- |

| name      | document.title | An app name to display in the Stacks wallet.         |

| icon      | /favicon.ico   | The path to an icon to display in the Stacks wallet. |

### ConfigOptions

Used to configure how the stx.me button behaves.

| Parameter      | Default                   | Description                                           |

| -------------- | ------------------------- | ----------------------------------------------------- |

| showAddress    | false                     | Display your stacks address on your webpage.          |

| appDetails     | See AppDetails            | Configuration for the Stacks wallet pop ups.          |

| successMessage | Thanks for your donation! | A message to display to users on successful donation. |

| buttonText     | Send Me STX               | A message to display on the donation button.          |

| network        | mainnet                   | The Stacks network transactions should be sent on.    |