aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMikunoNaka <bokuwakanojogahoshii@yahoo.com>2021-07-08 09:12:24 +0530
committerMikunoNaka <bokuwakanojogahoshii@yahoo.com>2021-07-08 09:12:24 +0530
commit6167f02d9dee6028987bef53fe658904d47e2d3f (patch)
treed884a0e26bdd10490b0a2e72e8f352cdf9b77796
parent165d47723a484ba84acf13d62f7ae8e4f1392347 (diff)
parentbb099574863278ec721c84caf556a64f94f319c0 (diff)
Merge branch 'main' of github.com:MikunoNaka/openbills
-rw-r--r--README.md28
1 files changed, 7 insertions, 21 deletions
diff --git a/README.md b/README.md
index 2fca8d1..7f92a08 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,18 @@
# OpenBills
-OpenBills is a very simple browser based invoicing software hosted locally and meant for use with standalone computers.
-It's ideal for small businesses and is meant to be customizable and easy to use.
-So everyone from a computer newbie to a power user can benifit from it.
+Somewhat minimal invoicing software with a web UI (Somewhat supports mobile phones)
-The front end is written in react.js and back end is written in Go.
-The backend is (supposed to be) a single executable that you run to start the app and then use the app in the browser by going to localhost:8080
+Great for small businesses, and completely free to use. Will support some really convenient features to easily organise everything
-## This project is highly under development and is being written by a newbie.
+## How to use
-Please consider contributing new features or optimizations.
-
-To contribute, fork the project, add your feature and issue a pull request. It's that simple! apparently
-
-
-## A summary of the features I want to implement
+That's the neat part, you don't (it's in nightly as of now, not complete)
-(not all of the features are here I've written them down and am too lazy to type it out)
+## Contributing
-1. Being able to save product and customer data so no need to type it all out all the time
-
-2. Password protect the app
-
-3. Support for multiple users with their own or optionally shared settings and data among a group of users
-
-4. Support for rendering a styled invoice document and options to export or print it
+Please consider contributing new features or optimizations.
-5. Many other things that I'll add hopefully
+To contribute, fork the project, add your feature and issue a pull request. It's that simple! apparently
## Licence