threedy v2.0.0
About The Project
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
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
Roadmap
See the open issues for a list of proposed features (and known issues).
Development/Contributions
Development
Version 2.0 of threedy includes a local development workbench for testing out the card. The "Entities" section of the workbench allows you to view and edit a local source of Home Assistant entities, or use the live entities of a connected Home Assistant instance. The "Config" section workbench allows you to modify the card's configuration programmatically or graphically.
To get started:
1. Clone the repository:
$ git clone https://github.com/dangreco/threedy && cd threedy2. Install dependencies:
$ yarn install3. Start development server:
$ yarn devContributing
Thank you for taking time to help make threedy better!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.
Acknowledgements
3 years ago