diff --git a/README.md b/README.md
index 3c717c8..3f6534d 100644
--- a/README.md
+++ b/README.md
@@ -41,16 +41,16 @@
PackageLock
- project_description
+ PackageLock aims to be the distro-agnostic 🔋-included one-stop Solution for patchmanagement on linux systems.
- Explore the docs (COMING SOON!) »
+ Explore the docs (COMING SOON!) »
- View Demo (COMING SOON!)
+ View Demo (COMING SOON!)
·
- Report Bug (COMING SOON!)
+ Report Bug (COMING SOON!)
·
- Request Feature (COMING SOON)
+ Request Feature (COMING SOON)
@@ -89,23 +89,8 @@
-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: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description
-
-(back to top)
-
-
-
-### Built With
-
-* [![Next][Next.js]][Next-url]
-* [![React][React.js]][React-url]
-* [![Vue][Vue.js]][Vue-url]
-* [![Angular][Angular.io]][Angular-url]
-* [![Svelte][Svelte.dev]][Svelte-url]
-* [![Laravel][Laravel.com]][Laravel-url]
-* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
-* [![JQuery][JQuery.com]][JQuery-url]
-
+I created PackageLock from the need to have a one-stop platform for package and software-management on my linux servers.
+I wanted to design and create a system that allowed me to create....
(back to top)
@@ -113,48 +98,24 @@ Here's a blank template to get started: To avoid retyping too much info. Do a se
## Getting Started
-This is an example of how you may give instructions on setting up your project locally.
-To get a local copy up and running follow these simple example steps.
+TODO: create getting started guide
+TODO: general deployment?
### Prerequisites
-This is an example of how to list things you need to use the software and how to install them.
-* npm
- ```sh
- npm install npm@latest -g
- ```
+TODO: create prerequisites
-### Installation
-1. Get a free API Key at [https://example.com](https://example.com)
-2. Clone the repo
- ```sh
- git clone https://github.com/github_username/repo_name.git
- ```
-3. Install NPM packages
- ```sh
- npm install
- ```
-4. Enter your API in `config.js`
- ```js
- const API_KEY = 'ENTER YOUR API';
- ```
-5. Change git remote url to avoid accidental pushes to base project
- ```sh
- git remote set-url origin github_username/repo_name
- git remote -v # confirm the changes
- ```
-
-(back to top)
+### Installation
+TODO: add installation instructions
## 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.
+TODO: explain usage
-_For more examples, please refer to the [Documentation](https://example.com)_
(back to top)
@@ -163,12 +124,12 @@ _For more examples, please refer to the [Documentation](https://example.com)_
## Roadmap
-- [ ] Feature 1
-- [ ] Feature 2
-- [ ] Feature 3
- - [ ] Nested Feature
+- [ ] backend-api to manage Agents & Hosts
+- [ ] frontend to visualize backend data
+- [ ] installable agent as background daemon
-See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
+TODO: create Issue template:
+See the [open issues](https://github.com/HilkopterBob/PackageLock/issues) for a full list of proposed features (and known issues).
(back to top)
@@ -192,8 +153,8 @@ Don't forget to give the project a star! Thanks again!
### Top contributors:
-
- 
+
+ 
@@ -210,39 +171,25 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
-Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
-
-Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)
+Project Link: [https://github.com/HilkopterBob/PackageLock](https://github.com/HilkopterBob/PackageLock)
(back to top)
-
-## Acknowledgments
-
-* []()
-* []()
-* []()
-
-(back to top)
-
-
-[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge
-[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
-[forks-url]: https://github.com/github_username/repo_name/network/members
-[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
-[stars-url]: https://github.com/github_username/repo_name/stargazers
-[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge
-[issues-url]: https://github.com/github_username/repo_name/issues
-[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
-[license-url]: https://github.com/github_username/repo_name/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/linkedin_username
+[contributors-shield]: https://img.shields.io/github/contributors/HilkopterBob/PackageLock.svg?style=for-the-badge
+[contributors-url]: https://github.com/HilkopterBob/PackageLock/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/HilkopterBob/PackageLock.svg?style=for-the-badge
+[forks-url]: https://github.com/HilkopterBob/PackageLock/network/members
+[stars-shield]: https://img.shields.io/github/stars/HilkopterBob/PackageLock.svg?style=for-the-badge
+[stars-url]: https://github.com/HilkopterBob/PackageLock/stargazers
+[issues-shield]: https://img.shields.io/github/issues/HilkopterBob/PackageLock.svg?style=for-the-badge
+[issues-url]: https://github.com/HilkopterBob/PackageLock/issues
+[license-shield]: https://img.shields.io/github/license/HilkopterBob/PackageLock.svg?style=for-the-badge
+[license-url]: https://github.com/HilkopterBob/PackageLock/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/