Docs: Updated README

This commit is contained in:
Paul Beckingham 2016-06-18 13:11:59 -04:00
parent 596c1751fe
commit bce2a58777

View file

@ -1,18 +1,14 @@
# Disclaimer during ongoing development # Disclaimer during ongoing development
We want to discourage you from using the development version of Timewarrior. As We want to discourage you from using the development version of Timewarrior.
a new project, it has initially no functionality, and will only annoy you. At
time of first release, there will be online documentation that explaions what
the prodcut is, and how it can help you. Until then, everything is a work in
progress.
The development branch is being actively updated and may not pass all quality The development branch is being actively updated and may not pass all quality
tests, therefore it may harm your data. In fact, as a new project, it doesn't tests, therefore it may harm your data. In fact, as a new project, it doesn't
have adequate tests to prove that anything works. We do not guarantee proper or have adequate tests to prove that everything works. We do not guarantee proper
even adequate functionality, performance or timely fixes. or even adequate functionality, performance or timely fixes.
We welcome bug reports from beta- and release-level software, but generally not We welcome bug reports from alpha-, beta- and release-level software, but
development versions. If you are undaunted by this, please: generally not development versions. If you are undaunted by this, please:
- Make proper backups. - Make proper backups.
- Expect broken and missing functionality. - Expect broken and missing functionality.
@ -27,10 +23,10 @@ Timewarrior is a time tracking utility that offers simple stopwatch features as
well as sophisticated calendar-base backfill, along with flexible reporting. It well as sophisticated calendar-base backfill, along with flexible reporting. It
is a portable, well supported and very active, Open Source project. is a portable, well supported and very active, Open Source project.
Timewarrior is a new project, but is growing every day, and will soon have Although Timewarrior is a new projec there is extensive online documentation.
online documentation and demonstrations. You'll find all the details at: You'll find all the details at:
http://taskwarrior.org http://taskwarrior.org/docs/timewarrior
At the site you'll find online documentation, downloads, news and more. At the site you'll find online documentation, downloads, news and more.