An open API service indexing awesome lists of open source software.

https://github.com/sytone/simplesettings

Simple setting solution for PowerShell and beyond!
https://github.com/sytone/simplesettings

Last synced: 25 days ago
JSON representation

Simple setting solution for PowerShell and beyond!

Awesome Lists containing this project

README

        

![Logo.](./images/settings_icon.png "Logo")

# Simple Settings

[![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]

Simple setting solution for PowerShell and beyond!

**[Explore the docs »](https://github.com/sytone/simplesettings)**

[View Demo](https://github.com/sytone/simplesettings) · [Report Bug](https://github.com/sytone/simplesettings/issues) · [Request Feature](https://github.com/sytone/simplesettings/issues)

Table of Contents

1. [About The Project](#about-the-project)
- [Built with](#built-with)
2. [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
3. [Usage](#usage)
4. [Roadmap](#roadmap)
5. [Contributing](#contributing)
6. [License](#license)
7. [Contact](#contact)
8. [Acknowledgements](#acknowledgements)

## About The Project

[![Simple Settings Screen Shot.][./images/screenshot.png]](https://github.com/sytone/simplesettings)

There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

- Your time should be focused on creating something amazing. A project that solves a problem and helps others
- You shouldn't be doing the same tasks over and over like creating a README from scratch
- You should element DRY principles to the rest of your life :smile:

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template!

A list of commonly used resources that I find helpful are listed in the acknowledgements.

### Built With

- [PowerShell Core](https://docs.microsoft.com/powershell/)
- [Visual Studio Code](https://code.visualstudio.com/)

## Getting Started

To get a local copy up and running follow these simple example steps.

### Prerequisites

- PowerShell Core 7.x+

### Installation

To install this module to use you can download the zip and extract to a local modules directory or install from the [PowerShell Gallery](https://www.powershellgallery.com/)

## 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/sytone/simplesettings/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 GPLv3 License. See `LICENSE` for more information.

## Contact

Jon Bullen - [@sytone](https://twitter.com/sytone)

Project Link: [https://github.com/sytone/simplesettings](https://github.com/sytone/simplesettings)

## Acknowledgements

- [Img Shields](https://shields.io)
- [Choose an Open Source License](https://choosealicense.com)

[contributors-shield]: https://img.shields.io/github/contributors/sytone/simplesettings.svg?style=for-the-badge
[contributors-url]: https://github.com/sytone/simplesettings/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/sytone/simplesettings.svg?style=for-the-badge
[forks-url]: https://github.com/sytone/simplesettings/network/members
[stars-shield]: https://img.shields.io/github/stars/sytone/simplesettings.svg?style=for-the-badge
[stars-url]: https://github.com/sytone/simplesettings/stargazers
[issues-shield]: https://img.shields.io/github/issues/sytone/simplesettings.svg?style=for-the-badge
[issues-url]: https://github.com/sytone/simplesettings/issues
[license-shield]: https://img.shields.io/github/license/sytone/simplesettings?style=for-the-badge
[license-url]: https://github.com/sytone/simplesettings/blob/main/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[product-screenshot]: images/screenshot.png