@@ -16,9 +16,10 @@
- About the project | - Getting started | - Get in touch + About the project | + Getting started | + How to contribute | + License
--- @@ -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. - [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 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. ---- +## 🤔 How to contribute -## :star2: Extras -- [Shields.io](https://shields.io/) -- [Github Emojis](https://gist.github.com/rxaviers/7360908) +- Fork this repository; +- Create a branch with your feature: `git checkout -b my-feature`; +- 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)