From dcd3d8eb6565c067c7ca96c442b0795377b566f2 Mon Sep 17 00:00:00 2001
From: Joe <49767913+joebudi@users.noreply.github.com>
Date: Mon, 23 Nov 2020 17:52:53 +0000
Subject: [PATCH] Badges and emojis added
---
readme.md | 40 ++++++++++++++++++++++++++++++++++++----
1 file changed, 36 insertions(+), 4 deletions(-)
diff --git a/readme.md b/readme.md
index 7ad26aecde..58ebc3f6fd 100644
--- a/readme.md
+++ b/readme.md
@@ -20,9 +20,26 @@
+
+
# Budibase
[Budibase](https://www.budibase.com) is an open-source low-code platform which helps developers and IT professionals design, build, and ship custom software 50x faster.
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+
# 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
@@ -45,16 +62,31 @@ If you are having issues between updates of the builder, please use the guide [h
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 and tutorial
+
+## 🎓 Learning Budibase
Our documentation and tutorials live here: https://docs.budibase.com
-## Contributing
+## 🙌 Contributing to Budibase
-Contributors, see [CONTRIBUTING.md](./CONTRIBUTING.md)
+From opening a bug report to creating a pull request: every contribution is appreciated and welcomed. If you're planning to implement a new feature or change the API please create an issue first. This way we can ensure your work is not in vain.
-## Get in touch
+### Not Sure Where to Start?
+Budibase is a monorepo managed by lerna. Lerna manages the building and publishing of the budibase packages. At a high level, here are the packages that make up budibase.
+
+- packages/builder - contains code for the budibase builder client side svelte application.
+
+- packages/client - A module that runs in the browser responsible for reading JSON definition and creating living, breathing web apps from it.
+
+- packages/server - The budibase server. This Koa app is responsible for serving the JS for the builder and budibase apps, as well as providing the API for interaction with the database and file system.
+
+For more information, see [CONTRIBUTING.md](./CONTRIBUTING.md)
+
+## 💬 Get in touch
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: