From 073ec31f171679a7ff47a03b9b7bdc8cad8d2bb9 Mon Sep 17 00:00:00 2001
From: Chris Troutner
Date: Mon, 6 Jul 2020 17:33:26 -0700
Subject: [PATCH] fix(README): Updating README
---
README.md | 19 +++++++++++--------
package.json | 5 +++++
2 files changed, 16 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 3b13551..476e904 100644
--- a/README.md
+++ b/README.md
@@ -5,22 +5,20 @@
- Gatsby's hello-world starter
+ A BCH Web Wallet Gatsby Starter
-Kick off your project with this hello-world boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React.
-
-_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._
+Create your own Bitcoin Cash web wallet app with this Gatsby Starter. This Starter leverages the [gatsby-ipfs-web-wallet Gatsby Theme](https://github.com/Permissionless-Software-Foundation/gatsby-ipfs-web-wallet). Additional plugins can be developed with the [bch-wallet-plugin-boilerplate](https://github.com/Permissionless-Software-Foundation/bch-wallet-plugin-boilerplate).
## π Quick start
1. **Create a Gatsby site.**
- Use the Gatsby CLI to create a new site, specifying the hello-world starter.
+ Use the Gatsby CLI to create a new site, specifying this starter.
```shell
# create a new Gatsby site using the hello-world starter
- gatsby new my-hello-world-starter https://github.com/gatsbyjs/gatsby-starter-hello-world
+ gatsby new my-bch-wallet-app https://github.com/Permissionless-Software-Foundation/bch-wallet-starter
```
1. **Start developing.**
@@ -28,7 +26,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti
Navigate into your new siteβs directory and start it up.
```shell
- cd my-hello-world-starter/
+ cd my-bch-wallet-app/
gatsby develop
```
@@ -38,7 +36,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti
_Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
- Open the `my-hello-world-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
+ Open the `my-bch-wallet-app` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
## π§ What's inside?
@@ -47,6 +45,9 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
.
βββ node_modules
βββ src
+ βββ gatsby-ipfs-web-wallet
+ βββ components
+ βββ menu-components.js
βββ .gitignore
βββ .prettierrc
βββ gatsby-browser.js
@@ -82,6 +83,8 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
12. **`README.md`**: A text file containing useful reference information about your project.
+12. **`menu-components.js`**: Allows you to add new menu items and Views to the app.
+
## π Learning Gatsby
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
diff --git a/package.json b/package.json
index 8f8bbfc..95e9e2f 100644
--- a/package.json
+++ b/package.json
@@ -3,6 +3,11 @@
"description": "A BCH web wallet starter for Gatsby.",
"version": "1.0.0",
"license": "MIT",
+ "author": "Chris Troutner ",
+ "contributors": [
+ "Daniel Gonzalez ",
+ "Andre Cabrera "
+ ],
"scripts": {
"build": "gatsby build",
"develop": "gatsby develop",