readme: Port to Markdown and update

The readme hasn't been updated in 11 years. Update to reflect the expected org.gnome.NautilusPreviewer2 interface, the sushi binary, and the nightly flatpak.

readme: Port to Markdown and update
ed277e63 · Corey Berla · fe72e3e4 · fe72e3e4 · ed277e63
Commit ed277e63 authored 2 years ago by Corey Berla
--- a/README
+++ b/README
-This is Sushi, a quick previewer for Nautilus, the GNOME desktop file manager.
------------------------------------------------------------------------------
-
-Sushi is a DBus-activated service. For Sushi to popup, applications will have
-to call the ShowFile method on the org.gnome.NautilusPreviewer interface.
-If you want to or debug Sushi without a calling application, you can use
-gdbus(1) to call the ShowFile method manually on the bus.
-
-=======
-Methods
-=======
-
-ShowFile(s: FileUri, i: ParentXid, b: CloseIfShown)
-
-Activates Sushi previewing the file at the provided URI.
-If a XID is specified, the Sushi window is made transient to that window.
-If the CloseIfShown parameter is TRUE, Sushi will close if it's already
-running.
-
-Close()
-
-Explicitly closes Sushi.
--- a/README.md
+++ b/README.md
+# Sushi
+
+This is Sushi, a quick previewer for Files (nautilus), the GNOME desktop file manager.
+
+## Using Sushi
+
+Sushi is a DBus-activated service. For Sushi to popup, applications will have to call the `ShowFile` method on the `org.gnome.NautilusPreviewer2` interface.
+
+If you want to debug Sushi without a calling application, you can use the `sushi <filename>` command.
+
+## Reporting issues
+
+Before filing an issue here, confirm that it has not been fixed on the latest nightly build.  The easiest way to do this is by installing the nightly flatpak.
+
+```
+flatpak remote-add --if-not-exists gnome-nightly https://nightly.gnome.org/gnome-nightly.flatpakrepo
+flatpak install gnome-nightly org.gnome.NautilusPreviewerDevel
+```
+
+After installing the nightly flatpak, you can launch Sushi via the below command, or by initiating a preview from the NautilusDevel nightly flatpak.
+
+`flatpak run org.gnome.NautilusPreviewerDevel <filename>`