aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authors1n <[email protected]>2019-08-06 19:42:34 -0700
committerGitHub <[email protected]>2019-08-06 19:42:34 -0700
commit14b5ef6794fbc87d68dbf496e3234782cdb6ba8b (patch)
tree9ea2fc7f98b6853ea50a602c36c4055a6718d2f6
parentUpdate README.md (diff)
downloadwallet-14b5ef6794fbc87d68dbf496e3234782cdb6ba8b.tar.xz
wallet-14b5ef6794fbc87d68dbf496e3234782cdb6ba8b.zip
Update README.md
-rw-r--r--README.md117
1 files changed, 113 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3118d02..d4c46fb 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,118 @@
-# wallet
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][https://img.shields.io/github/forks/s1nical/wallet.svg?style=flat-square]][https://github.com/s1nical/wallet/network/members]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+ <a href="https://github.com/othneildrew/Best-README-Template">
+ <img src="images/logo.png" alt="Logo" width="80" height="80">
+ </a>
+
+ <h3 align="center">wallet</h3>
+
+ <p align="center">
+ A JavaScript Creation.
+ <br />
+ <a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a>
+ <br />
+ <br />
+ <a href="https://github.com/s1nical/wallet">View Demo</a>
+ ·
+ <a href="https://github.com/s1nical/wallet/issues">Report Bug</a>
+ ·
+ <a href="https://github.com/s1nical/wallet/issues">Request Feature</a>
+ </p>
+</p>
+
+
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+
+* [About the Project](#about-the-project)
+ * [Built With](#built-with)
+* [Getting Started](#getting-started)
+ * [Prerequisites](#prerequisites)
+ * [Installation](#installation)
+* [Usage](#usage)
+* [Roadmap](#roadmap)
+* [Contributing](#contributing)
+* [License](#license)
+* [Contact](#contact)
+* [Acknowledgements](#acknowledgements)
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+Wallet is a simple JavaScript creation to animate a sprite.
+
+A list of commonly used resources that I find helpful are listed in the acknowledgements.
+
+<!-- CONTRIBUTING -->
## Contributing
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
-Please make sure to update tests as appropriate.
+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
-[![MIT](https://img.shields.io/badge/license-MIT_License_with_anime_exception-green.svg)](https://github.com/s1nical/s1ns-private/blob/master/LICENSE)
+
+Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
+
+
+
+<!-- CONTACT -->
+## Contact
+
+s1nical - [@s1nical](https://twitter.com/your_username) - [email protected]
+
+Project Link: [https://github.com/s1nical/wallet](https://github.com/s1nical/wallet)
+
+
+
+<!-- ACKNOWLEDGEMENTS -->
+## Acknowledgements
+* [Amazon Web Services](https://aws.amazon.com/)
+
+
+
+
+
+<!-- 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