From 4a2eadf80aae00bd2abcf715daa2d380a1a4cf7d Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Sun, 19 Jun 2022 07:16:19 -0700 Subject: [PATCH] Customizing README and package.json --- README.md | 25 +++++++++++++++++++++++-- package.json | 2 +- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ec0f144..dd3387f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,27 @@ -# nft-browser-v2 +# react-bootstrap-web3-spa -This is a single page app (SPA) based on [react-bootstrap](https://www.npmjs.com/package/react-bootstrap). This app leverages the [Cash Stack](https://cashstack.info) web3 architecture to retrieve NFT information from the Bitcoin Cash (BCH) blockchain and display them. +This is a single page app (SPA) based on [react-bootstrap](https://www.npmjs.com/package/react-bootstrap). This app is a template to show how to build a web app that leverages the [Cash Stack](https://cashstack.info) web3 architecture, a censorship-resistant back-end for accessing the Bitcoin Cash blockchain. + +This app can be compiled and uploaded to Filecoin via [web3.storage](https://web3.storage). This means a censorship-resistant front-end app (SPA) can be built, which communicates with a censorship-resistant back-end. + +## Major Features +- [react-bootstrap](https://react-bootstrap.github.io/) is used for general style and layout control. +- An easily customized *waiting modal* component can be invoked while waiting for network calls to complete. +- [minimal-slp-wallet](https://www.npmjs.com/package/minimal-slp-wallet) is used to access tokens and BCH on the Bitcoin Cash blockchain. +- A 'server selection' dropdown allows the user to select from an array of redundant back end servers. +- This site is statically compiled, uploaded to Filecoin, and served over IPFS for censorship resistance and version control. + +## Installation +```bash +git clone https://github.com/Permissionless-Software-Foundation/react-bootstrap-web3-spa +cd react-bootstrap-web3-spa +npm install +npm start +npm run build +``` + +## Support +The [Permissionless Software Foundation](https://psfoundation.cash) is a collection of JavaScript developers and entrepreneurs. Join our [bch-js-toolkit Telegram channel](https://t.me/bch_js_toolkit) to get community-based technical help and meet like-minded individuals. ## License [MIT](./LICENSE.md) diff --git a/package.json b/package.json index ee1e8a1..9e279da 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "nft-browser-v2", + "name": "react-bootstrap-web3-spa", "version": "1.0.0", "dependencies": { "axios": "0.27.2",