d6a5771e01
- Revamp README.md with improved project overview, architecture diagram, and badges - Create new development and tools documentation with detailed guides - Update API documentation with enhanced examples, rate limiting, and security information - Refactor and consolidate documentation files for better navigation and clarity - Add emojis and visual improvements to make documentation more engaging
30 lines
1.2 KiB
Markdown
30 lines
1.2 KiB
Markdown
# Getting Started
|
|
|
|
Begin your journey with the Home Assistant MCP Server by following these steps:
|
|
|
|
- **API Documentation:** Read the [API Documentation](api.md) for available endpoints.
|
|
- **Real-Time Updates:** Learn about [Server-Sent Events](sse-api.md) for live communication.
|
|
- **Tools:** Explore available [Tools](tools/tools.md) for device control and automation.
|
|
- **Configuration:** Refer to the [Configuration Guide](configuration.md) for setup and advanced settings.
|
|
|
|
## Troubleshooting
|
|
|
|
If you encounter any issues:
|
|
1. Verify that your Home Assistant instance is accessible.
|
|
2. Ensure that all required environment variables are properly set.
|
|
3. Consult the [Troubleshooting Guide](troubleshooting.md) for additional solutions.
|
|
|
|
## Development
|
|
|
|
For contributors:
|
|
1. Fork the repository.
|
|
2. Create a feature branch.
|
|
3. Follow the [Development Guide](development/development.md) for contribution guidelines.
|
|
4. Submit a pull request with your enhancements.
|
|
|
|
## Support
|
|
|
|
Need help?
|
|
- Visit our [GitHub Issues](https://github.com/jango-blockchained/homeassistant-mcp/issues).
|
|
- Review the [Troubleshooting Guide](troubleshooting.md).
|
|
- Check the [FAQ](troubleshooting.md#faq) for common questions. |