Skip to content

Commit de759bd

Browse files
authored
Update readme docs for linktree (spheronFdn#1)
* Update README.md
1 parent 5c12239 commit de759bd

File tree

1 file changed

+22
-40
lines changed

1 file changed

+22
-40
lines changed

README.md

Lines changed: 22 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,34 @@
1-
# link-tree-app
2-
Link Tree App powered by Spheron
1+
# Custom Linktree Utilising Web3 Infra :muscle:
2+
Now power your marketing and branding with your custom domain utilising Spheron.
33

4-
## Config for the App
5-
1. Go to `config.ts` file which is present in `/src` directory.
6-
2. Update the relevant information such as title, description, social media URLs etc.
7-
3. Run the App to see the changes.
8-
## Commands for running the Link Tree App
9-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
4+
## Why on Web3 Infrastructure ?
105

11-
## Available Scripts
6+
Web3 Infrastructure comes with its pros on top of what you get on Web2.
7+
Some of the examples are, your links generated here will never die if you keep your ipfs hash handy somewhere safe and any one node has pinned it.
128

13-
In the project directory, you can run:
9+
## Why use Spheron?
10+
You can use any app to deploy this on the decentralised network but
11+
Spheron makes the entire process of pinning your hash and backing up for a longer duration of time makes much easier. Apart from it, users can also easily attach their domain via Spheron and serve millions with our best-in-class CDN build on top of the Web3 Infrastructure layer.
1412

15-
### `npm start`
13+
## How to launch ?
1614

17-
Runs the app in the development mode.\
18-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
15+
There are multiple way's to launch your own custom domain based linktree app for your self utilising Spheron.
16+
The best way to achieve the same is via forking or cloning to your local and launching it in few lines or few clicks depending on what you like the most.
1917

20-
The page will reload if you make edits.\
21-
You will also see any lint errors in the console.
18+
### Follow these steps to launch via Spheron UI:
2219

23-
### `npm test`
20+
- Fork this repo
21+
- Open https://app.spheron.network
22+
- Install Github Spheron App if you have not yet and give the access to repo
23+
- Choose your favourite Decentralised Network
24+
- Hit on a Deploy
2425

25-
Launches the test runner in the interactive watch mode.\
26-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
2726

28-
### `npm run build`
27+
### Follow this steps to launch it via Spheron CLI:
2928

30-
Builds the app for production to the `build` folder.\
31-
It correctly bundles React in production mode and optimizes the build for the best performance.
29+
Coming Soon.........
3230

33-
The build is minified and the filenames include the hashes.\
34-
Your app is ready to be deployed!
31+
## Support Spheron
3532

36-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
37-
38-
### `npm run eject`
39-
40-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
41-
42-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
43-
44-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
45-
46-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
47-
48-
## Learn More
49-
50-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
51-
52-
To learn React, check out the [React documentation](https://reactjs.org/).
33+
If you loved utilising this template, please do share it your friends over social media tagging Spheron and you can also add powered by Spheron template in your custom link.
34+
This will help us to grow and expand Web3 Infra presence

0 commit comments

Comments
 (0)