From 3c19d28adcfc76be00b8b5475f6983b65f56cf22 Mon Sep 17 00:00:00 2001 From: mangeshrex Date: Sat, 14 Sep 2024 23:28:52 +0530 Subject: [PATCH] update readme because it was really needed --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 05dcace..195edcd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ -# commit -## commit +# [commit](https://commit.frappe.cloud/) -The Commit Company +Born out of a need to improve developer tooling for Frappe, "Commit" allows you to visualize your app's database schema and view all it's APIs - improving developer productivity and security of your critical applications. + +## Basic Installation + +The below guide assumes that you already have a working Frappe and Bench installation. If you do not have it, then please head over to [Official Installation Guide](https://frappeframework.com/docs/user/en/installation). + +Go ahead and create a fresh new bench + +- `bench init commit` +- `bench get-app https://github.com/The-commit-company/commit` +- `bench new-site ` +- `bench --site install-app commit` + +Commit will now be accessible on https://:8000/commit.