Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
liamcottle committed Nov 19, 2024
1 parent d3f6205 commit 14f035d
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# MeshTXT
<h2 align="center">MeshTXT</h2>

A simple, mobile friendly, web based Meshtastic client.
<p align="center">
<a href="https://discord.gg/K55zeZyHKK"><img src="https://img.shields.io/badge/Discord-Liam%20Cottle's%20Discord-%237289DA?style=flat&logo=discord" alt="discord"/></a>
<a href="https://twitter.com/liamcottle"><img src="https://img.shields.io/badge/Twitter-@liamcottle-%231DA1F2?style=flat&logo=twitter" alt="twitter"/></a>
<br/>
<a href="https://ko-fi.com/liamcottle"><img src="https://img.shields.io/badge/Donate%20a%20Coffee-liamcottle-yellow?style=flat&logo=buy-me-a-coffee" alt="donate on ko-fi"/></a>
<a href="./donate.md"><img src="https://img.shields.io/badge/Donate%20Bitcoin-3FPBfiEwioWHFix3kZqe5bdU9F5o8mG8dh-%23FF9900?style=flat&logo=bitcoin" alt="donate bitcoin"/></a>
</p>

|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)

<img src="./screenshots/screenshot.png">

## What can it do?

Expand All @@ -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

```
Expand Down
9 changes: 9 additions & 0 deletions donate.md
Original file line number Diff line number Diff line change
@@ -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)
Binary file added screenshots/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 14f035d

Please sign in to comment.