north-star / commit
link changes and readme additions
readme.md | 22 ++++++++++------------ src/index.html | 6 ++---- 2 files changed, 12 insertions(+), 16 deletions(-) diff --git a/readme.md b/readme.md index e5b3b5c..d95f35a 100644 --- a/readme.md +++ b/readme.md @@ -6,15 +6,14 @@ North Star is a web application that allows users to share their location in rea ## How to use it? -1. Open `https://pavelsafronov.gitlab.io/north-star/` -2. You're in a room now. -3. Share the room QR code or the room link with your friends so they can join the same room. -4. Everyone who joins the room will be able to see each other's location on the map. -5. Everyone can set a custom name and color for their marker. -6. You can disable participants or click on a participant's name to open their location in Google Maps. -7. The North participant is a special marker that always points to the north, helping you orient yourself on the map. -8. If North isn't pointing to true north, orient your phone so "up" on the screen is facing north, and then click the "Calibrate North" button. This will set the current orientation as north. -9. A mis-aligned north is only a visual issue and does not affect the actual location sharing functionality. +1. Open [https://pavelsafronov.gitlab.io/north-star/](https://pavelsafronov.gitlab.io/north-star/) +2. Share the room QR code or the room link with your friends so they can join the same room. +3. Everyone who joins the room will be able to see each other's relative location on the map. +4. Everyone can set a custom name and color for their marker. +5. You can hide participants or click on a participant's name to open their location in Google Maps. +6. The North participant is a special marker that always points to the north. +7. If North isn't pointing to true north, orient your phone so "up" on the screen is facing north, and then click the "Calibrate North" button. This will set the current orientation as north. +8. A mis-aligned north is only a visual issue and does not affect the actual location sharing functionality. ## How does it work? @@ -24,11 +23,11 @@ The app uses Firebase Realtime Database to store and sync the location data of a The app does not require any authentication, so anyone with the room information can join and see the location of all participants. -The room QR code contains a URL with a unique room id and a unique encryption key. This means that even if someone were to gain access to the database (like myself, or a bad actor), they would not be able to read anyone's location data without the room link. +The room link/QR code contains a unique room id and a unique encryption key. This means that even if someone were to gain access to the database (like myself, or a bad actor), they would not be able to read anyone's location data without the room link. It's important to share the room QR code/link only with trusted individuals to ensure your privacy. -If your link gets leaked, you can simply create a new room and share the new QR code/link with your friends. +If your link gets leaked or compromised, you can simply create a new room and share the new QR code/link with your friends. ## Links @@ -58,4 +57,3 @@ You're looking at it. ### License This project is licensed under the MIT License. - diff --git a/src/index.html b/src/index.html index 655be75..79fdf06 100644 --- a/src/index.html +++ b/src/index.html @@ -24,12 +24,10 @@ </head> <body> - <p class="app-title"><a href="https://gitlab.com/PavelSafronov/north-star" target="_blank" - rel="noopener noreferrer">North Star</a></p> + <p class="app-title"><a href="https://pavelsafronov.gitlab.io/north-star/">North Star</a></p> <div class="room-header"> <p id="room-current" class="room-current"></p> - <a id="create-room-link" href="https://pavelsafronov.gitlab.io/north-star/" target="_blank" - rel="noopener noreferrer">Create New Room</a> + <a id="create-room-link" href="https://pavelsafronov.gitlab.io/north-star/">Create New Room</a> </div> <form id="name-form" class="name-form" autocomplete="off"> <input id="self-name-input" name="selfName" type="text" maxlength="32" enterkeyhint="done" />