-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Build out README and CONTRIBUTING docs (#21)
* Build out README and CONTRIBUTING * Apply Review
- Loading branch information
Showing
2 changed files
with
40 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Contributing to Temporal in Rust | ||
|
||
This project is currently highly experimental and fairly volatile. As such, while we do | ||
welcome contributions, we prefer that you open up an issue first beforehand to ensure | ||
the feature is not being actively worked on by a maintainer. | ||
|
||
If you're interested in helping out but don't see an issue that's for you, please feel free to contact | ||
us on the `Boa` discord. | ||
|
||
## Contributor Information | ||
|
||
`Temporal` is a new date/time API that is being developed and proposed for the `ECMAScript` | ||
specification. This library aims to be a `Rust` implementation of that specification. | ||
|
||
Due to the current experimental nature of the material and this library, we would advise | ||
potential contributors to familiarize themselves with the Temporal specification. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,29 @@ | ||
# Temporal in Rust | ||
|
||
Provides a standard API for working with dates and time. | ||
:warning: This crate is highly experimental and NOT stable. We cannot make any guarantee that the API will be stable until `0.1.0`. Do not use in production without extreme caution :warning: | ||
|
||
IMPORTANT NOTE: The Temporal Proposal is still in Stage 3. As such, this crate should be viewed | ||
as highly experimental until the proposal has been completely standardized and released. | ||
`Temporal` is a calendar and timezone aware date/time library that is currently being designed and proposed as a new | ||
builtin to the `ECMAScript` specification. | ||
|
||
## Goal | ||
This crate is an implementation of `Temporal` in Rust. While initially developed for the `Boa`, the crate has been externalized | ||
as we intended to make an engine agnostic and general usage implementation of `Temporal` and its algorithms. | ||
|
||
The intended goal of this crate is to provide an engine agnostic | ||
implementation of `ECMAScript`'s Temporal algorithms. | ||
## Temporal Proposal | ||
|
||
Relevent links regarding Temporal can be found below. | ||
|
||
-[Temporal Documentation](https://tc39.es/proposal-temporal/docs/) | ||
-[Temporal Specification](https://tc39.es/proposal-temporal/) | ||
-[Temporal Repository](https://github.com/tc39/proposal-temporal) | ||
|
||
## Contributing | ||
|
||
This project is open source and welcomes anyone interested to participate. Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information. | ||
|
||
## Communication | ||
|
||
Feel free to contact us on [Discord](https://discord.gg/tUFFk9Y). | ||
|
||
## License | ||
|
||
This project is licensed under the [Apache](./LICENSE-Apache) or [MIT](./LICENSE-MIT) licenses, at your option. |