Skip to content

Commit

Permalink
Update bs-abstract to Bastet in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
mlms13 committed May 24, 2020
1 parent a16a7d1 commit a9b9b29
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Expand Up @@ -11,17 +11,19 @@ Relude Eon is a ReasonML library for working with type-safe date and time values

**Install via npm:**

`npm install --save relude-eon relude bs-abstract`
```sh
npm install --save relude-eon relude bs-bastet
```

`relude` and `bs-abstract` are peerDependencies of eon.
`relude` and `bs-bastet` are peerDependencies of Relude Eon in order to [avoid duplicate copies of dependencies](https://reazen.github.io/relude/#/FAQ?id=why-does-relude-use-peer-dependencies-for-everything-rather-than-hard-production-dependencies).

**Update your bsconfig.json**

```
"bs-dependencies": [
"relude-eon",
"relude",
"bs-abstract"
"bs-bastet"
],
```

Expand All @@ -33,15 +35,15 @@ This just might be useful!

- All of the core building blocks are there (see below)
- The useful types (e.g. `Instant`, `LocalDate`, `LocalTime`) all support basic date math
- Basic interop with `Js.Date` exists
- Most things have at least _some_ tests
- Conversion functions to/from `Js.Date` exist
- Most existing functionality is reasonably well-tested

### Not Quite Yet

- Durations (for generic date math, building ranges, etc)
- Weekdays
- String functions (parsers, formatters)
- Timezones (we have offsets, but currently there's no support for named zones, daylight savings time, etc)
- Timezones (we have UTC offsets, but there's not yet support for named zones, daylight savings time, etc)

### Currently Out-Of-Scope

Expand Down

0 comments on commit a9b9b29

Please sign in to comment.