Skip to content

Commit

Permalink
docs: overhaul readme and building instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hrzlgnm committed Oct 21, 2024
1 parent 66b67e4 commit f92cf0f
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 16 deletions.
4 changes: 2 additions & 2 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Prerequisites

More information is available in [Tauri-Prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites/#setting-up-linux)
More information is available in [Tauri-Prerequisites](https://tauri.app/start/prerequisites/)

### Additional targets for rust

Expand All @@ -20,7 +20,7 @@ rustup target add wasm32-unknown-unknown

Installation using package-manager

See also official [tauri-instructions](https://tauri.app/v1/guides/getting-started/prerequisites/#setting-up-linux)
See also official [tauri-instructions](https://tauri.app/start/prerequisites/#linux)

#### xbps

Expand Down
58 changes: 44 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,64 @@
# mDNS-Browser

This application allows you to browse services using mDNS.

<!--toc:start-->

- [mDNS-Browser](#mdns-browser)
- [Building](#building)
- [Where EXE?](#where-exe)
- [github releases](#github-releases)
- [winget](#winget)
- [mDNS-Browser Overview](#mdns-browser)
- [How to Build](#building)
- [Where to find the executables?](#where-to-find-the-executables)
- [GitHub Release](#github-releases)
- [Winget Installation](#winget)
- [Arch Linux (AUR)](#arch-linux-aur)
- [Acknowledgments](#acknowledgments)
<!--toc:end-->

This app allows for browsing of services using mDNS

## Building

See [BUILDING](BUILDING.md) document.
For instructions on building the application, checkout the [BUILDING](BUILDING.md) document.

## Where to find the executables?

## Where EXE?
### GitHub Releases

### github releases
You can download the latest version of the application from the [GitHub Release page](https://github.com/hrzlgnm/mdns-browser/releases/latest)

The latest release can be downloaded here [Release](https://github.com/hrzlgnm/mdns-browser/releases/latest)
### Winget installation

### winget
To install via Winget, run the following command:

```console
winget install mdns-browser
```

### Arch Linux (AUR)

To install on Arch Linux using the AUR, you can use an AUR helper like yay or paru:

With `yay`:

```console
yay -S mdns-browser
```

Alternatively using the -bin package:

```console
yay -S mdns-browser-bin
```

With `paru`:

```console
paru -S mdns-browser
```

Alternatively using the -bin package:

```console
paru -S mdns-browser-bin
```

## Acknowledgments

The main workhorse of this application is the great library [mdns-sd](https://github.com/keepsimple1/mdns-sd) used to do all the mDNS magic happening in the backend of the app.
Consider giving the repo a star if you like this application.
This app uses the fantastic [mdns-sd library](https://github.com/keepsimple1/mdns-sd)to handle all mDNS functionality. If you find this app helpful, consider giving the library a star on GitHub!

0 comments on commit f92cf0f

Please sign in to comment.