diff --git a/README.md b/README.md index 02181ef..1b3dd59 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ -# MeshTXT +

MeshTXT

-A simple, mobile friendly, web based Meshtastic client. +

+discord +twitter +
+donate on ko-fi +donate bitcoin +

-|Nodes | Messages | Trace Routes | -|:---:|:---:|:---:| -|![](screenshots/3_nodes.png) | ![](screenshots/4_direct_messages.png) | ![](screenshots/5_trace_routes.png) | +A simple, mobile friendly, web based [Meshtastic](https://meshtastic.org/) client developed by [Liam Cottle](https://liamcottle.com) + + ## What can it do? @@ -18,6 +24,16 @@ A simple, mobile friendly, web based Meshtastic client. - Mark and unmark a node as a favourite - Filter nodes to only show favourites +## Is there a hosted version? + +Yes! I have a hosted web client available at https://meshtxt.liamcottle.net + +I would however suggest that you self host this so you can still use it when the internet is down. + +Sometime in the future I may add support for caching of the PWA assets, but for now this is not implemented. + +Do note that connecting to your Meshtastic device over HTTP has some limitations due to CORS. Consider using the [server.js](./server.js) script to resolve these issues. + ## Running Locally ``` diff --git a/donate.md b/donate.md new file mode 100644 index 0000000..0507b31 --- /dev/null +++ b/donate.md @@ -0,0 +1,9 @@ +# Donate + +Thank you for considering donating, this helps support my work on this project 😁 + +## How can I donate? + +- Bitcoin: 3FPBfiEwioWHFix3kZqe5bdU9F5o8mG8dh +- Buy me a Coffee: [https://ko-fi.com/liamcottle](https://ko-fi.com/liamcottle) +- Sponsor on GitHub: [https://github.com/sponsors/liamcottle](https://github.com/sponsors/liamcottle) diff --git a/screenshots/screenshot.png b/screenshots/screenshot.png new file mode 100644 index 0000000..a6059db Binary files /dev/null and b/screenshots/screenshot.png differ