FumeNodes/linktree
1
0
Fork 0
mirror of https://github.com/johnggli/linktree.git synced 2026-08-16 22:46:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
John Emerson
2021-11-26 15:55:38 -03:00
committed by GitHub
parent d0f7a090ae
commit 5210a4a555
1 changed files with 26 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -1,4 +1,4 @@
<h1 align="center">:evergreen_tree: Linktree</h1> <h1 align="center">🌲 Linktree</h1>
<h3 align="center">Simple site to group all my profiles on social networks in one place.</h3> <h3 align="center">Simple site to group all my profiles on social networks in one place.</h3>
<p align="center"> <p align="center">
@@ -16,9 +16,10 @@
</p> </p>
<p align="center"> <p align="center">
<a href="#bulb-about-the-project">About the project</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp; <a href="#-about-the-project">About the project</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#rocket-getting-started">Getting started</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp; <a href="#-getting-started">Getting started</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#star2-extras">Get in touch</a> <a href="#-how-to-contribute">How to contribute</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#-license">License</a>
</p> </p>
--- ---
@@ -29,24 +30,37 @@
--- ---
## :bulb: About the project ## 💡 About the project
This is an open source project that serves as a free alternative to the Linktree website. This is an open source project that serves as a free alternative to the Linktree website.
- [Demo](https://johnemerson1406.github.io/linktree) - [Demo](https://johnemerson1406.github.io/linktree)
## :rocket: Getting started ## 🚀 Getting started
- Clone the repository If you installed git you can clone the code to your machine, or download a ZIP of all the files directly.
[Download the ZIP from this location](https://github.com/JohnEmerson1406/linktree/archive/master.zip), or run the following [git](https://git-scm.com/downloads) command to clone the files to your machine:
```bash
git clone https://github.com/JohnEmerson1406/linktree
```
- Once the files are on your machine, open the _linktree_ folder in [Visual Studio Code](https://code.visualstudio.com/).
- With the files open in Visual Studio Code, press the **Go Live** button at the bottom of the window to launch the files with [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer).
- Change the profile image and texts in the `index.html` file. - Change the profile image and texts in the `index.html` file.
- Change the colors and fonts in the `style.css` file. - Change the colors and fonts in the `style.css` file.
- To change the background, go to the `style.css` file on line 17, uncomment the code snippet and change the url to whatever image you want. - To change the background, go to the `style.css` file on line 17, uncomment the code snippet and change the url to whatever image you want.
--- ## 🤔 How to contribute
## :star2: Extras - Fork this repository;
- [Shields.io](https://shields.io/) - Create a branch with your feature: `git checkout -b my-feature`;
- [Github Emojis](https://gist.github.com/rxaviers/7360908) - Commit your changes: `git commit -m "feat: my new feature"`;
- Push to your branch: `git push origin my-feature`.
Once your pull request has been merged, you can delete your branch.
## 📝 License
This project is under the MIT license. See the [LICENSE](LICENSE.md) file for more details.
--- ---
Made with ♥ by John Emerson :wave: [Get in touch](https://johnemerson1406.github.io/linktree) Made with ❤️ by John Emerson :wave: [Get in touch](https://johnemerson1406.github.io/linktree)