diff --git a/.github/images/community-logos.png b/.github/images/community-logos.png new file mode 100644 index 0000000000..9275c8a10f Binary files /dev/null and b/.github/images/community-logos.png differ diff --git a/README.md b/README.md index c87836934e..62fbe84099 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,66 @@ -# Fluidd -Fluidd is a free and open-source Klipper web interface for managing your 3d printer. +

+ +

-![Fluidd](/.github/images/preview_sliced.png?raw=true "Fluidd") +

+ 📜 Download +  |  + 📖 Docs +  |  + 💭 FAQ +  |  + ⚙️ Configs +  |  + 🧱 Contribute +

-## Features -- Responsive UI, supports desktop, tablets and mobile -- Customizable layouts. Move any panel where YOU want -- Built-in color themes -- Manage multiple printers from one Fluidd install -- [See our docs for more!](https://docs.fluidd.xyz) +

+ GitHub release (latest by date) + GitHub downloads + Docker Pulls + GitHub language count + GitHub commit activity +

-## Support & Documentation -See our [Docs](https://docs.fluidd.xyz). -Join our [Discord!](https://discord.gg/GZ3D5tqfcF). +Community Logos -## Where to download? -You can download the latest release [here](https://github.com/cadriel/fluidd/releases/latest). +## Key Features -Older releases can be found [here](https://github.com/cadriel/fluidd/releases). +- Responsive UI made for *desktop, tablet & mobile*! +- Customize you dashboard! Choose what you want to see and move every panel where YOU want! +- Built-in color and community themes, pick a logo you like! +- Manage multiple printers from one Fluidd install! +- Fast development cycle and active devs! +- Multi language support! +- [See our docs for a lot more!](https://docs.fluidd.xyz) -## Docker -We have an official docker image. This is updated for each release. -https://hub.docker.com/r/cadriel/fluidd +# Support & Documentation +

+ GitHub closed issues + Discord +

+ +Looking for support? [Check out our docs](https://docs.fluidd.xyz) or [open an issue](https://github.com/cadriel/fluidd/issues/new/choose)! + +Have a killer idea you'd like to see implemented? Join our [Discord](https://discord.gg/GZ3D5tqfcF) to discuss bugs, features and share fireside fluidd stories. + +# Where can I get it? +You can get your hands on the latest release of *fluidd* [here](https://github.com/cadriel/fluidd/releases/latest), while older releases can be found [here](https://github.com/cadriel/fluidd/releases). + +We also have an official docker image! This is updated for each release and can be found [here](https://hub.docker.com/r/cadriel/fluidd). + + +# How do I use it? -## How to use? Fluidd is distributed as a RaspbiOS image, with Fluidd pre-installed and setup alongside its dependencies. The recommended approach is to flash a fresh image using FluiddPI. Please see the [docs](https://docs.fluidd.xyz) for help with installation and configuration. -### Credit +# Credit A big thank you to; + - the [Voron Community](http://vorondesign.com/) - Kevin O'Connor for [Klipper](https://github.com/KevinOConnor/klipper) - Eric Callahan for [Moonraker](https://github.com/Arksine/moonraker) -- Ray for [MainsailOS](https://github.com/raymondh2/MainsailOS)