Skip to content

Commit 2633e5a

Browse files
committed
Change readme and banner text to reflect the current state
The "does not reflect the current consensus" text was mainly to indicate that the consensus included calendars while the polyfill did not. That has now changed. We should now emphasize that the API is experimental and the polyfill should not be used in production, and give a prominent link to where feedback can be given.
1 parent 5c982d3 commit 2633e5a

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ The specification text can be found [here](https://tc39.es/proposal-temporal/).
4848
A complete polyfill can be found [here](./polyfill).
4949
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.
5050

51+
**NOTE:** We encourage you to experiment with the polyfill, but don't use it in production!
52+
The API will change before the proposal reaches Stage 3, based on feedback that we receive during this time.
53+
Please give us your feedback in the [issue tracker](https://github.com/tc39/proposal-temporal/issues).
54+
5155
## Cookbook
5256

5357
A cookbook to help you get started and learn the ins and outs of Temporal is available [here](./docs/cookbook.md)

docs/head.html.part

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
</head>
8181
<body>
8282
<div class="banner">
83-
<strong>This polyfill is a work in progress.</strong>
84-
It does not represent the final API of this proposal, nor even the current consensus.
83+
This proposal is <strong>experimental.</strong>
84+
The API will change based on feedback that we get.
85+
<strong>Do</strong> <a href="https://github.com/tc39/proposal-temporal/issues">give feedback</a>; <strong>don't</strong> use it in production!
8586
</div>

polyfill/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
**Polyfill for [Proposal: Temporal](https://github.com/tc39/proposal-temporal)**
44

5+
**NOTE:** We encourage you to experiment with the polyfill, but don't use it in production!
6+
The API will change before the proposal reaches Stage 3, based on feedback that we receive during this time.
7+
Please give us your feedback in the [issue tracker](https://github.com/tc39/proposal-temporal/issues).
8+
59
Please run the polyfill with Node.js 12 or later.
610

711
## Import as a Module

0 commit comments

Comments
 (0)