about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..498e06d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Furtherance
+Furtherance is a time tracking app written in Rust with GTK 4.
+It allows you to track time spent on different activities without worrying about your data being captured and sold.
+
+<p float="left">
+    <img src="https://raw.githubusercontent.com/lakoliu/Furtherance/main/screenshots/furtherance-screenshot-main.png" alt="Furtherance main window" width="250"/>
+    <img src="https://raw.githubusercontent.com/lakoliu/Furtherance/main/screenshots/furtherance-screenshot-task-details.png" alt="Furtherance task details" width="250"/>
+    <img src="https://raw.githubusercontent.com/lakoliu/Furtherance/main/screenshots/furtherance-screenshot-edit-task.png" alt="Furtherance edit task" width="250"/>
+    <img src="https://raw.githubusercontent.com/lakoliu/Furtherance/main/screenshots/furtherance-screenshot-settings.png" alt="Furtherance settings" width="250"/>
+</p>
+
+## Features
+* Tasks are saved in a database with an unlimited capacity. It can be backed up for security and portability.
+* Tasks are grouped by name and date.
+* Tasks can be edited after they are created (name, time, and date).
+* Settings to customize the view and defaults to your liking.
+* Features can be added! Just email your request.
+
+## Getting Started
+Just install Furtherance using Flatpak and you'll be off to the races.
+
+## Use
+Type in the name of the task you are working on and press start. That's really all there is to it.
+
+## Project Details
+
+### Built With
+Furtherance is written in Rust using the Gtk-rs bindings for GTK 4.
+
+### License
+This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.
+
+### Author
+This project is created and maintained by [Ricky Kresslein](https://kressle.in) under [lakoliu](https://lakoliu.com). More information at [Furtherance.app](https://furtherance.app).