LICENSE and README

LICENSE

@@ -0,0 +1,16 @@
+MIT No Attribution
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,7 +1,45 @@
-# Tauri + Preact + Typescript
+# Ping UI
 
-This template should help get you started developing with Tauri, Preact and Typescript in Vite.
+A simple GUI for the `ping` command-line utility built using Tauri.
 
-## Recommended IDE Setup
+Requires `ping` to be in the PATH and for the output of `ping` to have the following format:
 
-- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
+```
+<BYTES> bytes from <HOST>: icmp_seq=<SEQ> ttl=<TTL> time=<TIME> ms
+ping: sendto: No route to host
+Request timeout for icmp_seq <SEQ>
+```
+
+If your version of `ping` doesn't work, create an issue or open a PR.
+
+## Compatibility
+
+✅ macOS (Fully compatible)
+
+❓ Windows (Untested)
+
+❓ Linux (Untested)
+
+## Development
+
+1. [Install Tauri](https://tauri.app/)
+2. Install JS dependencies
+  ```bash
+  yarn install
+  ```
+3. Run tests
+  ```bash
+  yarn test
+  ```
+4. Run Tauri dev
+  ```bash
+  yarn tauri dev
+  ```
+5. (Optional) Build Tauri application
+  ```bash
+  yarn tauri build
+  ```
+
+## License
+
+The source code is released under the [MIT No Attribution](https://choosealicense.com/licenses/mit-0/) license. Copyright notice is intentionally omitted.