Add Readme

[0suu]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @0suu, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's documentation by adding comprehensive README files in both Japanese and English, alongside a detailed device support matrix. These additions aim to provide clear guidance on the application's functionality, setup, and device compatibility, thereby improving the overall user and developer experience.

Highlights

• Comprehensive Documentation Added: This pull request introduces extensive documentation for the SwitchBot Controller application, making it easier for both users and developers to understand and utilize the project.
• Device Support Matrix: A new DEVICE_SUPPORT_MATRIX.md file has been added, providing a detailed list of SwitchBot devices and their current support status within the application, along with a clear status legend.
• Bilingual README Files: Both Japanese (README.md) and English (README_en.md) versions of the main project documentation have been added, covering features, usage instructions, developer setup, requirements, and security notes, enhancing accessibility for a wider audience.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds important documentation to the project, including a device support matrix and README files in both English and Japanese. The documentation is well-structured and comprehensive. My review focuses on improving clarity and consistency. I've identified a few minor issues, such as a contradictory note and an undefined status in the device support matrix, and an inconsistent command in the English README. Addressing these points will help ensure the documentation is clear and accurate for all users and developers.

[gemini-code-assist]

The note states that "all devices are marked as ?", but the table below lists several devices with 〇 (Fully supported) or △ (Partially supported). This is contradictory and could confuse users. Please update the note to accurately reflect the status of the device support documentation.

Suggested change

	> For now, all devices are marked as `?` (unknown / 未検証).
	> For now, many devices are marked as `?` (unknown / 未検証).

[gemini-code-assist]

The status 〇? for "Meter" is not defined in the status legend. This can be confusing for users trying to understand the support level. Please use one of the defined statuses from the legend (〇, △, ?, ×) for consistency. If you intend to convey a status like "supported but not fully verified", consider adding a new entry to the legend or clarifying in the "Notes / メモ" column.

[gemini-code-assist]

The instructions mention running npm run dev or npm run start. However, npm run start is not mentioned in the "Developer Setup Guide" section later in this file, nor is it in the Japanese README.md. This inconsistency could confuse developers. Please verify if npm run start is a valid command for this project and update the documentation to be consistent. If it's not a valid command, it should be removed.

Suggested change

	- If you are running from source, see the “Developer Setup” section below and run `npm run dev` or `npm run start`.
	- If you are running from source, see the “Developer Setup” section below and run `npm run dev`.