diff --git a/README.md b/README.md index 59fc704..c877b86 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,11 @@ Tasks is a simplistic Go webapp to manage tasks, I built this tool to manage tas How to use? ================== +Via script: `bash install.sh` + +This will generate the binary and set up the database. If you want, you can copy the binary and the public folder into a folder of your choice. + +Manually: 1. `go get github.com/thewhitetulip/Tasks` 1. change dir to the respective folder and create the db file: `cat schema.sql | sqlite3 tasks.db` @@ -11,32 +16,36 @@ How to use? 1. `./Tasks` 1. open [localhost:8081](http://localhost:8081) -You can change the port in the [config] (https://github.com/thewhitetulip/Tasks/blob/master/config.json) file +You can change the port in the [config](https://github.com/thewhitetulip/Tasks/blob/master/config.json) file ##Features -1. Add, update, delete task -2. Search tasks, the query is highlighted in the search results page -3. We use github flavoured markdown, which enables us for using a task list, advanced syntax highlighting and much more +1. Add, update, delete task. +2. Search tasks, the query is highlighted in the search results page. +3. Github flavoured markdown, which enables us for using a task list, advanced syntax highlighting and much more. 4. Supports file upload, randomizes the file name, stores the user given filename in a db and works on the randomized file name for security reasons. -5. Priorities are assigned, High = 3, medium = 2 and low = 1, sorting is done on priority descending and created date ascending +5. Priorities are assigned, High = 3, medium = 2 and low = 1, sorting is done on priority descending and created date ascending. 6. Categories are supported, you can add tasks to different categories. +1. Ability to hide a task from the timeline. +1. For a task list, shows 6 out of 8 tasks completed. +1. Single click install, just run the install.sh file. + ##### Book -I am learning writing webapps with Go as I build this application, I took to writing an introductory book about [building webapps in Go] (https://github.com/thewhitetulip/web-dev-golang-anti-textbook) because I faced a lot of problems while learning how to write webapps in Go, it, the book strives to teach by practical examples. You are welcome to contribute to the book. +I am learning writing webapps with Go as I build this application, I took to writing an introductory book about [building webapps in Go](https://github.com/thewhitetulip/web-dev-golang-anti-textbook) because I faced a lot of problems while learning how to write webapps in Go, it, the book strives to teach by practical examples. You are welcome to contribute to the book. #Screenshots The Home Page -![Home Page] (https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd.png) +![Home Page](https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd.png) Add Task dialog -![Add Task] (https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd-Add%20task.png) +![Add Task](https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd-Add%20task.png) Navigation drawer -![Navigation Drawer] (https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd%20Navigation%20Drawer.png) +![Navigation Drawer](https://github.com/thewhitetulip/Tasks/blob/master/screenshots/FrontEnd%20Navigation%20Drawer.png) #License diff --git a/screenshots/FrontEnd Navigation Drawer.png b/screenshots/FrontEnd Navigation Drawer.png index 197d7ef..046828d 100644 Binary files a/screenshots/FrontEnd Navigation Drawer.png and b/screenshots/FrontEnd Navigation Drawer.png differ diff --git a/screenshots/FrontEnd-Add task.png b/screenshots/FrontEnd-Add task.png index 6b6c289..10f2a4c 100644 Binary files a/screenshots/FrontEnd-Add task.png and b/screenshots/FrontEnd-Add task.png differ diff --git a/screenshots/FrontEnd.png b/screenshots/FrontEnd.png index 3f24c9b..d9db714 100644 Binary files a/screenshots/FrontEnd.png and b/screenshots/FrontEnd.png differ