diff --git a/README.md b/README.md index 4acc5dd..20c7ddf 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ -![Flatrun](res/social_preview.png) +# Flatrun - Run Flatpaks without installing! -Run `flatrun run path ` to run a .flatpak file! +Run the graphical user interface: -Or, run a flatpak from flathub with `flatrun run name flathub `! +```sh +flatpak run io.github.ryanabx.flatrun --gui +``` + +Or, run a .flatpak bundle straight from the terminal!: -Try `flatrun --gui` to run the graphical interface! +```sh +flatpak run io.github.ryanabx.flatrun bundle [PATH] +``` > **NOTE:** Please help test this and [Submit ISSUES](https://github.com/ryanabx/flatrun/issues/new) when you come across them! @@ -13,5 +19,11 @@ Try `flatrun --gui` to run the graphical interface! **Flatpak is the only supported method of building Flatrun**. Install `flatpak-builder` and run: ```sh -flatpak-builder --install --user .build flatpak/io.github.ryanabx.flatrun.yml -``` \ No newline at end of file +flatpak-builder --install --user [BUILD_DIR] flatpak/io.github.ryanabx.flatrun.yml +``` + +## Screenshots + +![Loading screen for Flatrun](res/screenshot1.png) + +![Running screen for Flatrun](res/screenshot2.png) \ No newline at end of file diff --git a/data/io.github.ryanabx.flatrun.metainfo.xml b/data/io.github.ryanabx.flatrun.metainfo.xml index cc323fc..1ebadf6 100644 --- a/data/io.github.ryanabx.flatrun.metainfo.xml +++ b/data/io.github.ryanabx.flatrun.metainfo.xml @@ -1,5 +1,5 @@ - + io.github.ryanabx.flatrun Flatrun CC0-1.0 diff --git a/docs/index.md b/docs/index.md index 16c081c..b858af3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,2 +1,5 @@ -# Flatrun +# Flatrun: https://github.com/ryanabx/flatrun +Run Flatpaks without installing them! + +[Submit issues](https://github.com/ryanabx/flatrun/issues/new) \ No newline at end of file diff --git a/flatpak/io.github.ryanabx.flatrun.yml b/flatpak/io.github.ryanabx.flatrun.yml index aa5a19b..5a99512 100644 --- a/flatpak/io.github.ryanabx.flatrun.yml +++ b/flatpak/io.github.ryanabx.flatrun.yml @@ -81,6 +81,6 @@ modules: sources: - type: git url: https://github.com/ryanabx/flatrun.git - tag: v0.1.0 + tag: v0.1.1 - generated-sources.json \ No newline at end of file diff --git a/res/screenshot1.png b/res/screenshot1.png new file mode 100644 index 0000000..edb4470 Binary files /dev/null and b/res/screenshot1.png differ diff --git a/res/screenshot2.png b/res/screenshot2.png new file mode 100644 index 0000000..4bac63f Binary files /dev/null and b/res/screenshot2.png differ