Skip to content

Commit 8fa4182

Browse files
committed
Refactor Temporal library documentation
1 parent 31a6493 commit 8fa4182

File tree

1 file changed

+25
-17
lines changed

1 file changed

+25
-17
lines changed

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,27 @@
11
# Temporal 🕧🕐🕜🕑🕝🕒
22

3-
A golang library for parsing and parsing, formatting and processing dates and
4-
times using simple human-friendly formats such as `yesterday`, `tomorrow`,
5-
`dd/mm/yyyy`, etc. The temporal does not aims to be a replacement for the
6-
standard time package, but rather addtional facilities to make regular date
7-
and time operations such as formatting, parsing, relative time, data range, etc.
8-
easier.
3+
Temporal is a Go language library designed to simplify the parsing, formatting,
4+
and processing of dates and times. While it does not intend to replace Go's
5+
standard time package, Temporal enhances it by providing additional, user-friendly
6+
functionalities that are practical for real-world applications. This library
7+
focuses on making common date and time operations, such as formatting, parsing,
8+
and working with relative times and date ranges, more accessible and efficient.
99

1010
## Why Temporal?
1111

12-
### ✨ Designed for Practicality
12+
### Key Features (Designed for Practicality)
1313

1414
It provides features are practical and useful in real-world applications. These
1515
features are either missing or not easy to use in the standard time package.
1616

17-
- [x] Parse dates using simple human-friendly formats such as `dd/mm/yyyy`, etc.
18-
- [x] Format dates using simple human-friendly formats such as `dd/mm/yyyy`, etc.
19-
- [x] Convert dates from one format to another. For example, `dd/mm/yyyy` to
20-
`yyyy-mm-dd`.
21-
- [x] Convert the datetime to relative time such as `few minutes ago`, `yesterday`, `5 days ago`, `3 years from now`, etc.
22-
etc.
23-
- [x] Provides range of date finder functions such as `Yesterday()`,
24-
`Tomorrow()`, `SoD()`, `EoD()`, etc.
25-
- [x] Provides range of date time utility functions such as `Latest()`,
26-
`Earliest()`, `IsBetween()`, `TruncateDate()`, etc.
17+
- [x] **Human-Friendly Parsing:** Effortlessly parse dates in intuitive formats
18+
like dd/mm/yyyy.
19+
- [x] **Easy Formatting:** Format dates using straightforward, human-readable formats.
20+
- [x] **Format Conversion:** Seamlessly convert dates between formats, e.g., from `dd/mm/yyyy` to `yyyy-mm-dd`.
21+
- [x] **Relative Time Processing:** Translate datetime into relative terms like `a few minutes ago`, `yesterday`, `5 days ago`, or `3 years from now`.
22+
- [x] **Finder Functions:** Utilize functions like `Yesterday()`, `Tomorrow()`, `SoD()` (Start of Day), and `EoD()` (End of Day) etc.
23+
- [x] **Utility Functions:** Access a suite of utility functions including `Latest()`,
24+
`Earliest()`, `IsBetween()`, `TruncateDate()`, and more.
2725

2826
### ✨ Developer Friendly
2927

@@ -38,6 +36,16 @@ formatting needs, making it an indispensable tool for Go developers.
3836
- [x] Fully documented 👌🏼
3937
- [x] Performance focused 👌🏼
4038

39+
### ✨ Ideal Use Cases
40+
41+
- [x] Developers needing intuitive date parsing and formatting.
42+
- [x] Applications requiring conversion between different date formats.
43+
- [x] Systems that display relative time representations.
44+
- [x] Software dealing with date range calculations and comparisons.
45+
- [x] Projects where standard time package features are insufficient or cumbersome.
46+
47+
Temporal stands out by offering features that are either missing or not as user-friendly in the standard time package, making it an invaluable addition to any Go developer's toolkit.
48+
4149
## Installation
4250

4351
Installation is simple. Just run the following command in your terminal to

0 commit comments

Comments
 (0)