From 3899d8c17dc5eb1dc0d03e6f25d29bda2878a5ff Mon Sep 17 00:00:00 2001 From: MikunoNaka Date: Tue, 27 Apr 2021 18:47:34 +0530 Subject: Updated README --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d611f8f..2fca8d1 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,36 @@ 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 and a power user can benifit from it. +So everyone from a computer newbie to a power user can benifit from it. The front end is written in react.js and back end is written in Go. -The backend is a single executable that you run to start the app and then use the app in the browser by going to localhost:8080 +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 +## This project is highly under development and is being written by a newbie. +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 + +(not all of the features are here I've written them down and am too lazy to type it out) + +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 + +5. Many other things that I'll add hopefully + +## Licence + +Licenced under The MIT Licence + +MIT: https://mit-license.org/ + +Copyright (c) 2021 Vidhu Kant Sharma -- cgit v1.2.3