diff options
| author | s1n <[email protected]> | 2019-08-14 18:15:24 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2019-08-14 18:15:24 -0700 |
| commit | 139195906eaaddec29103f4305d13887d6c596b6 (patch) | |
| tree | 1ece6cdf1a8ec8d582bd1f2e49504ca9bbf04fdd | |
| parent | delete unused files (diff) | |
| download | url-checkback-tool-139195906eaaddec29103f4305d13887d6c596b6.tar.xz url-checkback-tool-139195906eaaddec29103f4305d13887d6c596b6.zip | |
Update README.md
| -rw-r--r-- | README.md | 66 |
1 files changed, 64 insertions, 2 deletions
@@ -1,5 +1,67 @@ -# **Demo of Product** +<!-- ABOUT THE PROJECT --> +## About The Project +URL checkback script made in Python 3.7 for a school project. -- *https://streamable.com/juevy* + +<!-- GETTING STARTED --> +## Getting Started + +[Clone or download](https://github.com/s1nical/url-checkback-tool) the project and run in your favourite choice of [IDE](https://en.wikipedia.org/wiki/IDE) or [Text Editor](https://en.wikipedia.org/wiki/Text_editor) with a Code Runner. + +> *[Code Runner](https://marketplace.visualstudio.com/items?itemName=formulahendry.code-runner) by [Jun Han](https://marketplace.visualstudio.com/publishers/formulahendry) on the [VSCode Marketplace](https://marketplace.visualstudio.com/) is my Code Runner of choice but you can feel free to use anything that works for you.* + +### Prerequisites + +This is an example of how to list things you need to use the software and how to install them. +* Python 3.7 or newer release. + + + +<!-- CONTRIBUTING --> +## Contributing + +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + + + +<!-- LICENSE --> +## License + +Distributed under the MIT License. See [`LICENSE`](/LICENSE) for more information. + + + +<!-- CONTACT --> +## Contact + +s1nical - [@s1nical](https://twitter.com/s1nical) - [email protected] + +Project Link: [https://github.com/s1nical/url-checkback-tool](https://github.com/s1nical/url-checkback-tool) + + + + + +<!-- MARKDOWN LINKS & IMAGES --> +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> +[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=flat-square +[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=flat-square +[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=flat-square +[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=flat-square +[issues-url]: https://github.com/othneildrew/Best-README-Template/issues +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=flat-square +[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/othneildrew +[product-screenshot]: images/screenshot.png |