Add more details to the project (#2)

.github/workflows/pages.yml

@@ -0,0 +1,44 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy to pages
+
+on:
+    # Runs on pushes targeting the default branch
+    push:
+        branches: ['main']
+
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+    group: 'pages'
+    cancel-in-progress: false
+
+jobs:
+    # Single deploy job since we're just deploying
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+            - name: Setup Pages
+              uses: actions/configure-pages@v3
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v2
+              with:
+                  # Upload Coverage Reports and static assets
+                  path: './concur/ops/docs'
+
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v2

README.md

@@ -1 +1,105 @@
-# concur
+<!-- markdownlint-configure-file { "MD004": { "style": "consistent" } } -->
+<!-- markdownlint-disable MD033 -->
+
+#
+
+<p align="center">
+  <picture>
+    <img src="https://equalsgibson.github.io/concur/concur.jpg" width="410" height="205" alt="Concur">
+  </picture>
+    <br>
+    <strong>Easily run concurrent goroutines safely</strong>
+</p>
+
+<!-- markdownlint-enable MD033 -->
+
+-   **Easy to use**: Get up and running with the library in minutes
+-   **Intuitive**: Get access to a powerful pattern within software development, without encountering common pitfalls or mistakes!
+-   **Actively developed**: Ideas and contributions welcomed!
+
+---
+
+<div align="right">
+
+[![Go][golang]][golang-url]
+[![Go Reference][goref]][goref-url]
+[![Go Report Card][goreport]][goreport-url]
+
+</div>
+
+## Getting Started
+
+`concur` is a Go library that allows you to safely and easily implement a concurrency pattern in your codebase. Install the latest version, and get up and running in minutes. 
+
+This library is currently used by the Five9-GO repository, to provide a reliable, safe way to interact with the Five9 API Websocket service.  
+
+### What is concurrency, and why is it useful?
+
+```
+Concurrency is the composition of independently executing computations.
+
+Concurrency is a way to structure software, particularly as a way to write clean code that interacts well with the real world.
+
+It is not parallelism. 
+
+	- Rob Pike, 2012
+```
+
+Simply put, concurrency in software allows you to create **fast**, **robust** systems that can be relied upon to be **consistent**. Some examples of what concurrency can do, as provided by the Go team:   
+
+- [A Prime Number Sieve](https://go.dev/play/p/9U22NfrXeq)
+- [An RSS Feed fetcher](https://cs.opensource.google/go/x/website/+/master:_content/talks/2013/advconc/realmain/realmain.go)
+
+### Common pitfalls of concurrency that this library prevents  
+- Race conditions
+- Deadlocks  
+- Unpredictable or "flaky" tests when testing concurrent data models (such as Websockets, which are inherently asynchronous messages being sent back and forth between systems)
+
+### Install
+
+```shell
+go get github.com/equalsgibson/concur@latest
+```
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, get inspired, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+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.txt` for more information.
+
+<!-- CONTACT -->
+
+## Contact
+
+[Chris Gibson (@equalsgibson)](https://github.com/equalsgibson)
+
+Project Link: [https://github.com/equalsgibson/concur](https://github.com/equalsgibson/concur)
+
+<!-- ACKNOWLEDGMENTS -->
+
+## Acknowledgments
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+
+[golang]: https://img.shields.io/badge/v1.21-000?logo=go&logoColor=fff&labelColor=444&color=%2300ADD8
+[golang-url]: https://go.dev/
+[goref]: https://pkg.go.dev/badge/github.com/equalsgibson/concur.svg
+[goref-url]: https://pkg.go.dev/github.com/equalsgibson/concur
+[goreport]: https://goreportcard.com/badge/github.com/equalsgibson/concur
+[goreport-url]: https://goreportcard.com/report/github.com/equalsgibson/concur