Martien/hass-to-be-good
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
9a20323188586219505f2d56ebd90740e3929de8
hass-to-be-good/README.md
Martien 9a20323188 Restructure repository for multiple integrations 
- Moved Strike integration to integrations/strike/
- Created main README.md with repository overview
- Updated URLs to Gitea repository (git.martien.io)
- Removed old root-level custom_components directory
- Set up structure to support multiple future integrations

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-26 14:54:35 +01:00

3.3 KiB
Raw Blame History

Home Assistant Custom Integrations

A collection of custom Home Assistant integrations for various services and devices.

hacs_badge

Available Integrations

🪙 Strike Bitcoin Sensor

Real-time Bitcoin price tracking using the Strike API.

Features:

  • Real-time BTC price monitoring
  • Configurable currency pairs
  • Customizable update intervals
  • Secure API key storage
  • Home Assistant UI configuration

Documentation | Installation Guide

Installation

HACS (Recommended)

Each integration in this repository is available through HACS as a custom repository.

  1. Open HACS in your Home Assistant instance
  2. Click on "Integrations"
  3. Click the three dots in the top right corner
  4. Select "Custom repositories"
  5. Add the repository URL for the specific integration:
    • Strike: https://git.martien.io/Martien/hass-to-be-good (then navigate to integrations/strike)
  6. Select category: "Integration"
  7. Click "Add"
  8. Search for the integration name in HACS
  9. Click "Download"
  10. Restart Home Assistant

Manual Installation

  1. Navigate to the specific integration folder (e.g., integrations/strike/)
  2. Copy the custom_components/<integration_name> folder to your Home Assistant custom_components directory
  3. Restart Home Assistant
  4. Follow the integration-specific setup instructions

Repository Structure

hass-to-be-good/
├── README.md                    # This file
├── .gitignore
└── integrations/
    └── strike/                  # Strike Bitcoin integration
        ├── README.md            # Integration documentation
        ├── hacs.json            # HACS configuration
        └── custom_components/
            └── strike/          # Integration code
                ├── __init__.py
                ├── config_flow.py
                ├── const.py
                ├── manifest.json
                └── sensor.py

Contributing

Contributions are welcome! To add a new integration or improve existing ones:

  1. Fork the repository
  2. Create a feature branch
  3. Add your integration in the integrations/ directory following the existing structure
  4. Include proper documentation (README.md, hacs.json, etc.)
  5. Submit a pull request

Integration Guidelines

Each integration should:

  • Be in its own folder under integrations/
  • Include a README.md with installation and usage instructions
  • Include a hacs.json configuration file
  • Follow Home Assistant development best practices
  • Include proper error handling and logging
  • Use async/await patterns
  • Include type hints and docstrings

Support

For issues, questions, or feature requests:

  • Open an issue on Gitea
  • Check existing issues for solutions
  • Include integration name in issue title
  • Provide Home Assistant logs when reporting bugs

License

This project is provided as-is for educational and personal use.

Acknowledgments