From c0f4b8594aef6de318205782b5a105673fa2238a Mon Sep 17 00:00:00 2001
From: bckelley
Date: Mon, 29 Mar 2021 14:25:37 -0500
Subject: [PATCH] reformatted readme
---
readme.md | 179 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 173 insertions(+), 6 deletions(-)
diff --git a/readme.md b/readme.md
index 0707db2..acc8834 100644
--- a/readme.md
+++ b/readme.md
@@ -1,9 +1,176 @@
-Project: DevWorkSpace
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
-Powershell script to automate your work flow
-DONE:
- - Create new repository on github.
-TODO:
- - Open the created directory in an IDE
+
+
+
+
+
+
+
+
+
+
+ project_description
+
+
+
+ Explore the docs »
+
+
+
+
+ View Demo
+ ·
+ Report Bug
+ ·
+ Request Feature
+
+
+
+
+
+
+
+ Table of Contents
+
+ -
+ About The Project
+
+
+ -
+ Getting Started
+
+
+ - Usage
+ - Roadmap
+ - Contributing
+ - License
+ - Contact
+ - Acknowledgements
+
+
+
+
+
+
+## About The Project
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Getting Started
+
+
+
+### Prerequisites
+
+* PowerShell v5.1.18362.752
+
+### Installation
+
+1. Change directory into your projects directory
+ ```sh
+ cd D:\Projects\
+ ```
+2. Clone the repo
+ ```sh
+ git clone https://github.com/bckelley/DevWorkSpace.git
+ ```
+3. Then add the module to your powershell profile
+ ``` sh
+ notepad $Profile
+ ```
+ ```
+ Import-Module "\path\to\module\DevWorkSpace.psm1" -WarningAction Ignore
+ ```
+
+
+
+## Usage
+
+Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
+
+_For more examples, please refer to the [Documentation](https://example.com)_
+
+
+
+
+## Roadmap
+
+See the [open issues](https://github.com/bckelley/DevWorkSpace/issues) for a list of proposed features (and known issues).
+
+
+
+
+## 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
+
+Distributed under the **GNU General Public License v3.0**. See `LICENSE` for more information.
+
+
+## Contact
+
+### Bradon Kelley
+* Twitter: [@bradonconrad](https://twitter.com/bradonconrad)
+* Email: [business@bradonckelley.me](business@bradonckelley.me)
+
+Project Link: [https://github.com/bckelley/DevWorkSpace](https://github.com/bckelley/DevWorkSpace)
+
+
+
+## Acknowledgements
+
+
+
+
+
+[contributors-shield]: https://img.shields.io/github/contributors/bckelley/DevWorkSpace.svg?style=for-the-badge
+[contributors-url]: https://github.com/bckelley/DevWorkSpace/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/bckelley/DevWorkSpace.svg?style=for-the-badge
+[forks-url]: https://github.com/bckelley/DevWorkSpace/network/members
+[stars-shield]: https://img.shields.io/github/stars/bckelley/DevWorkSpace.svg?style=for-the-badge
+[stars-url]: https://github.com/bckelley/DevWorkSpace/stargazers
+[issues-shield]: https://img.shields.io/github/issues/bckelley/DevWorkSpace.svg?style=for-the-badge
+[issues-url]: https://github.com/bckelley/DevWorkSpace/issues
+[license-shield]: https://img.shields.io/github/license/bckelley/DevWorkSpace.svg?style=for-the-badge
+[license-url]: https://github.com/bckelley/DevWorkSpace/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/in/bckelley
\ No newline at end of file