Skip to content

Add Notestation Usage section #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zfields merged 1 commit into from
Feb 19, 2026
Merged

Add Notestation Usage section #157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@ Before running an example, you will need to set the Product Identifier, either
in code or on your connected Notecard. Steps on how to do this can be found at
[https://dev.blues.io/tools-and-sdks/samples/product-uid](https://dev.blues.io/tools-and-sdks/samples/product-uid).

## Notestation Usage

To gain access to the Tailscale VPN for Notestation, create a `.env` file based on `.env.example` in the `.devcontainer/notestation/` folder. This will set up the necessary environment variables for VPN access.

Copilot AI Feb 19, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section references creating a .env file for Tailscale, but it doesn’t explicitly call out that TS_AUTHKEY must be replaced with a valid key (per .devcontainer/notestation/.env.example) and that the auth key is sensitive. Consider adding a brief note to update TS_AUTHKEY and not share/commit the resulting .env file.

Suggested change
To gain access to the Tailscale VPN for Notestation, create a `.env` file based on `.env.example` in the `.devcontainer/notestation/` folder. This will set up the necessary environment variables for VPN access.
To gain access to the Tailscale VPN for Notestation, create a `.env` file based on `.env.example` in the `.devcontainer/notestation/` folder. Be sure to replace the `TS_AUTHKEY` placeholder with your valid Tailscale auth key, and treat this file as sensitive (do not share it or commit it to version control), as it contains credentials used for VPN access.

Copilot uses AI. Check for mistakes.

## Contributing

Expand Down Expand Up @@ -315,4 +318,4 @@ Copyright (c) 2019 Blues Inc. Released under the MIT license. See
[note-python]: https://github.com/blues/note-python
[archive]: https://github.com/blues/note-arduino/archive/master.zip
[code of conduct]: https://blues.github.io/opensource/code-of-conduct
[Notehub]: https://notehub.io
[Notehub]: https://notehub.io

Copilot AI Feb 19, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.md defines both [notehub] and [Notehub] reference links (both pointing to https://notehub.io). This duplication is unnecessary and makes link maintenance harder; consider standardizing on a single reference label and updating the uses accordingly (e.g., keep [notehub] and change [notehub.io][Notehub] to [notehub.io][notehub]).

Copilot uses AI. Check for mistakes.
Loading