Skip to content

Commit

Permalink
Readme & doc changes for Stage 3
Browse files Browse the repository at this point in the history
  • Loading branch information
justingrant committed Mar 11, 2021
1 parent d240c9a commit e73f9d0
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 23 deletions.
34 changes: 14 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,23 @@ Provides standard objects and functions for working with dates and times.

## Champions

- Maggie Pint ([@maggiepint](https://github.com/maggiepint))
- Philipp Dunkel ([@pipobscure](https://github.com/pipobscure))
- Matt Johnson ([@mj1856](https://github.com/mj1856))
- Brian Terlson ([@bterlson](https://github.com/bterlson))
- Shane Carr ([@sffc](https://github.com/sffc))
- Ujjwal Sharma ([@ryzokuken](https://github.com/ryzokuken))
- Philip Chimento ([@ptomato](https://github.com/ptomato))
- Jason Williams ([@jasonwilliams](https://github.com/jasonwilliams))
- Justin Grant ([@justingrant](https://github.com/justingrant))
- Maggie Pint ([@maggiepint](https://github.com/maggiepint))
- Philipp Dunkel ([@pipobscure](https://github.com/pipobscure))
- Matt Johnson ([@mj1856](https://github.com/mj1856))
- Brian Terlson ([@bterlson](https://github.com/bterlson))
- Shane Carr ([@sffc](https://github.com/sffc))
- Ujjwal Sharma ([@ryzokuken](https://github.com/ryzokuken))
- Philip Chimento ([@ptomato](https://github.com/ptomato))
- Jason Williams ([@jasonwilliams](https://github.com/jasonwilliams))
- Justin Grant ([@justingrant](https://github.com/justingrant))

## Status

This proposal is currently [Stage 2](https://github.com/tc39/proposals#stage-2).
This proposal is currently [Stage 3](https://github.com/tc39/proposals#stage-3).
Stage 3 reviewers were: Richard Gibson, Bradley Farias, and Daniel Ehrenberg.

At the time of writing, all the major design decisions that we are aware of have been made.
The proposal is under review by the TC39 delegates and the bar for making subsequent changes is high.
Nonetheless, changes may occur as the result of feedback from TC39 reviews and implementation in JS engines.

Stage 3 Reviewers:

- Richard Gibson
- Bradley Farias
- Daniel Ehrenberg
This proposal is now in the hands of ECMAScript engine implementers, so the bar for making subsequent changes is extremely high.
Nonetheless, changes may occur as the result of feedback from implementation in JS engines.

## Overview / Motivation

Expand All @@ -54,7 +48,7 @@ A complete polyfill can be found [here](./polyfill).
When viewing the [reference documentation](https://tc39.es/proposal-temporal/docs/index.html), the polyfill is automatically loaded in your browser, so you can try it out by opening your browser's developer tools.

**NOTE:** We encourage you to experiment with the polyfill, but don't use it in production!
The API may change before the proposal reaches Stage 3.
The API may change based on feedback from implementers.

## Documentation

Expand Down
3 changes: 1 addition & 2 deletions docs/head.html.part
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@
</head>
<body>
<div class="banner">
This proposal is <strong><a href="https://blogs.igalia.com/compilers/2020/06/23/dates-and-times-in-javascript/">experimental.</a></strong>
It is being reviewed by TC39.
This Stage 3 proposal is <strong><a href="https://blogs.igalia.com/compilers/2020/06/23/dates-and-times-in-javascript/">experimental.</a></strong>
<strong>Do</strong> try it out and <a href="https://github.com/tc39/proposal-temporal/issues">report bugs</a>; <strong>don't</strong> use it in production!
</div>
4 changes: 3 additions & 1 deletion polyfill/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**Polyfill for [Proposal: Temporal](https://github.com/tc39/proposal-temporal)**

**NOTE:** We encourage you to experiment with the polyfill, but don't use it in production!
The API may change before the proposal reaches Stage 3, based on feedback from TC39 reviews and implementation in JS engines.
The API may change based on feedback from implementation in JS engines.
Please report bugs in the [issue tracker](https://github.com/tc39/proposal-temporal/issues).

Please run the polyfill with Node.js 12 or later.
Expand All @@ -23,11 +23,13 @@ $ npm install --save proposal-temporal
```

In code:

```javascript
const { Temporal } = require('proposal-temporal');
```

Or, import the polyfill as an ES6 module:

```javascript
import { Temporal } from 'proposal-temporal/lib/index.mjs';
```
Expand Down

0 comments on commit e73f9d0

Please sign in to comment.