From 9c9c6b9fbd817aa4fcd381821fb219dfe99da785 Mon Sep 17 00:00:00 2001 From: dros Date: Tue, 30 Jul 2024 13:39:46 +0200 Subject: [PATCH] Clarifications, links added, Links fixed Signed-off-by: dros --- README.md | 42 ++++++++++++++++++++++++++---------------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ccbcfb4e48..f9a267b7af 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- Sublime's custom image +Sublime's custom image

![v5-develop phpunit](https://github.com/invoiceninja/invoiceninja/workflows/phpunit/badge.svg?branch=v5-develop) @@ -8,25 +8,29 @@ # Invoice Ninja 5 -## [Hosted](https://www.invoiceninja.com) | [Self-Hosted](https://www.invoiceninja.org) +Invoice Ninja Version 5 is here! We've taken the best parts of version 4 and added the most requested features to create an invoicing application like no other. Check the [Invoice Ninja YouTube Channel](https://www.youtube.com/@appinvoiceninja) to get up to speed. -Join us on [Slack](http://slack.invoiceninja.com), [Discord](https://discord.gg/ZwEdtfCwXA), [Support Forum](https://forum.invoiceninja.com) +**Choose your setup** -## Introduction +- [Hosted](https://www.invoiceninja.com): Our hosted version is a Software as a Service (SaaS) solution. You're up and running in under 5 minutes, with no need to worry about hosting or server infrastructure. +- [Self-Hosted](https://www.invoiceninja.org): For those who prefer to manage their own hosting and server infrastructure. This version gives you full control and flexibility. -Version 5 of Invoice Ninja is here! -We took the best parts of version 4 and add the most requested features -to produce a invoicing application like no other. +All Pro and Enterprise features from the hosted app are included in the open-source code. We offer a $30 per year white-label license to remove the Invoice Ninja branding from client-facing parts of the app. -All Pro and Enterprise features from the hosted app are included in the open code. -We offer a $30 per year white-label license to remove the Invoice Ninja branding from client facing parts of the app. +#### Get social with us -* [Videos](https://www.youtube.com/@appinvoiceninja) -* [API Documentation](https://api-docs.invoicing.co/) -* [APP Documentation](https://invoiceninja.github.io/) * [Support Forum](https://forum.invoiceninja.com) +* [Slack](http://slack.invoiceninja.com) +* [Discord](https://discord.gg/ZwEdtfCwXA) -## Setup +#### Documentation + +* [Invoice Ninja - API](https://api-docs.invoicing.co/) +* [Invoice Ninja - Developer Guide](https://invoiceninja.github.io/en/developer-guide/) +* [Invoice Ninja - User Guide](https://invoiceninja.github.io/en/user-guide/) +* [Invoice Ninja - Self-Hosted Installation Guide](https://invoiceninja.github.io/en/self-host-installation/) + +## Installation Options and Clients ### Mobile Apps * [iPhone](https://apps.apple.com/app/id1503970375?platform=iphone) @@ -39,16 +43,21 @@ We offer a $30 per year white-label license to remove the Invoice Ninja branding * [Linux - Snap](https://snapcraft.io/invoiceninja) * [Linux - Flatpak](https://flathub.org/apps/com.invoiceninja.InvoiceNinja) -### Installation Options +### Self-Hosted Server Installation +**Note:** The self-hosted options do support the desktop and mobile apps. + +* [Server or VM](https://invoiceninja.github.io/en/self-host-installation/) * [Docker File](https://hub.docker.com/r/invoiceninja/invoiceninja/) -* [Cloudron](https://cloudron.io/store/com.invoiceninja.cloudronapp.html) +* [Cloudron](https://www.cloudron.io/store/com.invoiceninja.cloudronapp2.html) * [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja) ### Recommended Providers * [Stripe](https://stripe.com/) * [Postmark](https://postmarkapp.com/) -## Quick Hosting Setup +## [Advanced] Quick Hosting Setup + +In addition to the official [Invoice Ninja - Self-Hosted Installation Guide](https://invoiceninja.github.io/en/self-host-installation/) we have a few commands for you. ```sh git clone --single-branch --branch v5-stable https://github.com/invoiceninja/invoiceninja.git @@ -84,6 +93,7 @@ pass: password ``` ## Developers Guide +In addition to the official [Invoice Ninja - Developer Guide](https://invoiceninja.github.io/en/developer-guide/) we've got your back with some insights. ### App Design