From 4f844f23932558dfca147d697b71851324cfe829 Mon Sep 17 00:00:00 2001 From: Joe <49767913+joebudi@users.noreply.github.com> Date: Sat, 31 Oct 2020 14:42:29 +0000 Subject: [PATCH] Readme update I updated the readme to provide the viewer with a better experience. --- readme.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index ec3c39bd5..eb40dd63c 100644 --- a/readme.md +++ b/readme.md @@ -1,13 +1,26 @@ -# Budibase is in Beta +# Budibase +[Budibase](https://www.budibase.com) is am open source no-code platform for building and deploying custom software. -Budibase is currently beta software. Until our official launch, we cannot ensure backwards compatibility for your budibase applications between versions. Issues may arise when trying to edit apps created with old versions of the budibase builder. +

+ +

+ +# Status +- [x] Alpha: We are demoing Budibase to users and receiving feedback +- [x] Private Beta: We are testing Budibase with a closed set of customers +- [x] Public Beta: Anyone can [sign-up and use Budibase](https://portal.budi.live/signup) but it's not production ready. We cannot ensure backwards compatibility +- [ ] Official Launch: Production-ready -If you are having issues between updates of the builder, please use the guide [here](https://github.com/Budibase/budibase/blob/master/CONTRIBUTING.md#troubleshooting) to clear down your environment. +We are currently in Public Beta. Until our official launch, we cannot ensure backwards compatibility for your budibase applications between versions. Issues may arise when trying to edit apps created with old versions of the budibase builder. -# What is Budibase? +Watch "releases" of this repo to get notified of major updates, amd give the star button a click whilst you're there. -Budibase is a platform for building web applications, without needing to write code. +

+ +

+ +If you are having issues between updates of the builder, please use the guide [here](https://github.com/Budibase/budibase/blob/master/CONTRIBUTING.md#troubleshooting) to clear down your environment. # Getting Started with Budibase @@ -15,9 +28,9 @@ Budibase is a platform for building web applications, without needing to write c The Budibase builder runs in Electron, on Mac, PC and Linux. [Download the latest release](https://github.com/Budibase/budibase/releases), and start building! -## Documentation +## Documentation and tutorial -A work in progress, lives here: https://docs.budibase.com +Our documentation and tutorials live here: https://docs.budibase.com ## Contributing @@ -25,7 +38,7 @@ Contributors, see [CONTRIBUTING.md](./CONTRIBUTING.md) ## Get in touch -If you have a question or would like to talk with other Budibase users, please join our Discord server: +If you have a question or would like to talk with other Budibase users, please hop over to [Github discussions](https://github.com/Budibase/budibase/discussions) or join our Discord server: [Discord chatroom](https://discord.gg/rCYayfe)