reformatted readme

2026-08-24 03:14:11 -05:00 · 2021-03-29 14:25:37 -05:00
parent 4b8bb74d0e
commit c0f4b8594a
1 changed files with 173 additions and 6 deletions
@@ -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 LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/bckelley/DevWorkSpace">
+    <!-- <img src="images/logo.png" alt="Logo" width="80" height="80"> -->
+  </a>
+
+  <h3 align="center">
+    <a href="https://github.com/bckelley/DevWorkSpace">
+        DevWorkSpace
+    </a>
+</h3>
+
+  <p align="center">
+    project_description
+    <br />
+    <a href="https://github.com/bckelley/DevWorkSpace">
+        <strong>
+            Explore the docs »
+        </strong>
+    </a>
+    <br />
+    <br />
+    <a href="https://github.com/bckelley/DevWorkSpace">View Demo</a>
+    ·
+    <a href="https://github.com/bckelley/DevWorkSpace/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/bckelley/DevWorkSpace/issues">Request Feature</a>
+  </p>
+</p>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details open="open">
+  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgements">Acknowledgements</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
+
+<!-- Here's a blank template to get started: -->
+<!-- **To avoid retyping too much info. Do a search and replace with your text editor for the following:** -->
+<!-- `bckelley`, `DevWorkSpace`, `twitter_handle`, `email`, `DevWorkSpace`, `project_description` -->
+
+
+<!-- ### Built With -->
+
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+<!-- To get a local copy up and running follow these simple steps. -->
+
+### 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 EXAMPLES -->
+## 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 -->
+## Roadmap
+
+See the [open issues](https://github.com/bckelley/DevWorkSpace/issues) for a list of proposed features (and known issues).
+
+
+
+<!-- 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 **GNU General Public License v3.0**. See `LICENSE` for more information.
+
+<!-- CONTACT -->
+## 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 -->
+## Acknowledgements
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[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