machankura/mempool
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Add mempool.js link to all examples.

Browse Source 
- Ignore files in dist folder, adding .gitkeep instead.
- Update readme text with CND instructions.
- Update readme badges.
- Update readme typo.
- Update all the html examples with new CDN link.
This commit is contained in:
Miguel Medeiros 2021-04-10 12:30:24 -03:00
parent 760bf97c1b
commit 2dd50add4a
11 changed files with 50 additions and 2499 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -1,2 +1,4 @@
/node_modules
/lib
/lib
/dist/*
!.gitkeep

29
README.md
View File

@ -1,9 +1,9 @@
# Mempool JS API
[![npm version](https://img.shields.io/npm/v/mempool-js.svg?style=flat-square)](https://www.npmjs.org/package/mempool-js)
[![NPM](https://img.shields.io/david/mempool/mempool-js.svg?style=flat-square)](https://david-dm.org/mempool/mempool-js#info=dependencies)
[![Known Vulnerabilities](https://snyk.io/test/github/mempool/mempool-js/badge.svg?style=flat-square)](https://snyk.io/test/github/mempool/mempool-js)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
[![npm version](https://badge.fury.io/js/%40mempool%2Fmempool-js.svg)](https://badge.fury.io/js/%40mempool%2Fmempool-js)
[![NPM](https://img.shields.io/david/mempool/mempool-js.svg)](https://david-dm.org/mempool/mempool-js#info=dependencies)
[![Known Vulnerabilities](https://snyk.io/test/github/mempool/mempool-js/badge.svg)](https://snyk.io/test/github/mempool/mempool-js)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
NPM package module for Mempool JS API.
@ -13,7 +13,7 @@ Documentation: [https://mempool.space/api](https://mempool.space/api)
## Features
- [Instalation](#installation)
- [Installation](#installation)
- [CommonJS](#commonjs)
- [NodeJS](#es-modules)
- [Usage](#usage)
@ -79,6 +79,7 @@ Then import the module.
```js
import mempoolJS from '@mempool/mempool-js';
const {
addresses,
blocks,
@ -104,7 +105,23 @@ const { address } = mempoolJS({
### **CommonJS**
First, include the script located on the `dist` folder.
We provide you our own link to `mempool-js`:
```html
<script type="text/javascript" src="https://mempool.space/mempool.js"></script>
```
If you want to run your own build, run the script:
```bash
# npm
$ npm run build
# yarn
$ yarn build
```
And, include the script located on the `dist` folder.
```html
<script type="text/javascript" src="./dist/mempool.min.js"></script>

0
dist/.gitkeep vendored Normal file
View File

2485
dist/mempool.js vendored
View File

File diff suppressed because it is too large Load Diff

1
dist/mempool.min.js vendored
View File

File diff suppressed because one or more lines are too long

5
examples/html/addresses.html
View File

@ -2,7 +2,10 @@
<html>
<head>
<title>Page Title</title>
<script src="./../../dist/mempool.js"></script>
<script
type="text/javascript"
src="https://mempool.space/mempool.js"
></script>
<script>
const init = async () => {
const { addresses } = mempoolJS();

5
examples/html/blocks.html
View File

@ -2,7 +2,10 @@
<html>
<head>
<title>Page Title</title>
<script src="./../../dist/mempool.js"></script>
<script
type="text/javascript"
src="https://mempool.space/mempool.js"
></script>
<script>
const init = async () => {
const { blocks } = mempoolJS();

5
examples/html/fees.html
View File

@ -2,7 +2,10 @@
<html>
<head>
<title>Page Title</title>
<script src="./../../dist/mempool.js"></script>
<script
type="text/javascript"
src="https://mempool.space/mempool.js"
></script>
<script>
const init = async () => {
const { fees } = mempoolJS();

5
examples/html/mempool.html
View File

@ -2,7 +2,10 @@
<html>
<head>
<title>Page Title</title>
<script src="./../../dist/mempool.js"></script>
<script
type="text/javascript"
src="https://mempool.space/mempool.js"
></script>
<script>
const init = async () => {
const { mempool } = mempoolJS();

5
examples/html/transactions.html
View File

@ -2,7 +2,10 @@
<html>
<head>
<title>Page Title</title>
<script src="./../../dist/mempool.js"></script>
<script
type="text/javascript"
src="https://mempool.space/mempool.js"
></script>
<script>
const init = async () => {
const { transactions } = mempoolJS();

5
examples/html/websocket.html
View File

@ -2,7 +2,10 @@
<html>
<head>
<title>Page Title</title>
<script src="./../../dist/mempool.js"></script>
<script
type="text/javascript"
src="https://mempool.space/mempool.js"
></script>
<script>
const init = async () => {
const { websocket } = mempoolJS();