Skip to content

Commit b1291c8

Browse files
committed
docs: clarify TagRelayLab repository roles and names
1 parent 49207d8 commit b1291c8

3 files changed

Lines changed: 19 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@ advertising resource. Your application and its keys stay under your control.
2929

3030
Complete API reference: [`docs/API.md`](docs/API.md)
3131

32+
## The three TagRelayLab projects
33+
34+
| Repository | Purpose |
35+
| --- | --- |
36+
| [TagRelayLab-ESP32-Library](https://github.com/Mattboxx/TagRelayLab-ESP32-Library) | This standalone firmware library; API, include and package name: `FindMyAdv`. |
37+
| [TagRelayLab-Appstores](https://github.com/Mattboxx/TagRelayLab-Appstores) | Public Docker installation catalog and illustrated guides for the optional tracking server. |
38+
| [TagRelayLab-Server](https://github.com/Mattboxx/TagRelayLab-Server) | Self-hosted map, saved history and provider management; source repository currently private. |
39+
40+
The library does not require TagRelayLab Server: use your own compatible
41+
provider/account workflow. Historical `Find_My_Web` or `find-my-hub` identifiers
42+
in existing integrations are compatibility names, not separate current projects.
43+
3244
<details>
3345
<summary>Italian documentation</summary>
3446

‎docs/README.it.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ Apple, Google o Espressif.
2121

2222
## Compatibilità
2323

24+
La famiglia comprende **TagRelayLab ESP32 Library** (questa libreria, API
25+
`FindMyAdv`), **TagRelayLab Server** (mappa e gestione, sorgenti attualmente
26+
privati) e [**TagRelayLab Appstores**](https://github.com/Mattboxx/TagRelayLab-Appstores)
27+
(installazione Docker e guide pubbliche). Il server TagRelayLab non è obbligatorio
28+
per usare la libreria con un proprio flusso provider/account compatibile.
29+
2430
Sono verificati ESP32 classico, ESP32-C3, ESP32-S3 ed ESP32-C6. Il backend
2531
predefinito usa NimBLE-Arduino e il GAP a basso livello. ESP32-C2, C5, C61 e H2
2632
restano sperimentali e non ancora verificati nella matrice del progetto: servono

‎docs/RELEASING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ manifest while packing it.
4444
Use the public `Mattboxx/TagRelayLab-ESP32-Library` repository and merge verified
4545
source through a protected pull request. For a newly approved version only,
4646
create a new version tag and attach its generated archive. Do not
47-
commit the personal `FindMyAdv-configured.zip` produced by Find_My_Web.
47+
commit the personal `FindMyAdv-configured.zip` produced by TagRelayLab Server.
4848

4949
## 4. Verify installation from GitHub
5050

0 commit comments

Comments
 (0)