Skip to content

Commit f03d6f2

Browse files
author
Justin Kimbrell
committed
chore: added readme
1 parent 93e29d3 commit f03d6f2

File tree

6 files changed

+45
-10
lines changed

6 files changed

+45
-10
lines changed

.changeset/pre.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"mode": "pre",
3+
"tag": "beta",
4+
"initialVersions": {
5+
"flipclock": "1.0.0-beta.1"
6+
},
7+
"changesets": [
8+
"real-cities-throw"
9+
]
10+
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
"flipclock": patch
33
---
44

5-
Bump to beta.1
5+
Updated README.md

.github/workflows/beta.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ jobs:
5252
run: |
5353
pnpm changeset pre enter beta
5454
55-
# Check if pre.json was created/modified
5655
if [ -f .changeset/pre.json ]; then
5756
git add .changeset/pre.json
5857
git commit -m "ci: enter prerelease mode for ${{ github.ref_name }}" || echo "No changes to commit"
@@ -62,9 +61,9 @@ jobs:
6261
uses: changesets/action@v1
6362
with:
6463
publish: pnpm changeset publish
65-
# env:
66-
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
67-
# NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
64+
env:
65+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
66+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
6867

6968
# Deployment job
7069
deploy:

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# flipclock
22

3-
## 1.0.0
3+
## 1.0.0-beta.1
44

55
### Patch Changes
66

7-
- test
7+
Initial release

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,29 @@
11
# FlipClock.js
22

3-
Insert README here.
3+
A full featured, themeable, type safe, and well tested library for clocks, timers, counters, and flipboards.
4+
5+
## Install
6+
7+
```bash
8+
pnpm add flipclock@beta
9+
```
10+
11+
```bash
12+
npm i flipclock@beta
13+
```
14+
15+
```bash
16+
yarn add flipclock@beta
17+
```
18+
19+
## Documentation
20+
21+
To check out docs, visit [https://flipclockjs.com/](https://flipclockjs.com/).
22+
23+
## Changelog
24+
25+
Detailed changes for each release are documented in the [CHANGELOG](https://github.com/objectivehtml/flipclock/blob/master/CHANGELOG.md).
26+
27+
## License
28+
29+
FlipClock.js is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "flipclock",
3-
"version": "1.0.0-beta.0",
3+
"version": "1.0.0-beta.1",
44
"description": "A full featured, themeable, type safe, and well tested library for clocks, timers, counters, and flipboards.",
55
"license": "MIT",
66
"author": "objectivehtml",
@@ -9,7 +9,7 @@
99
"type": "git",
1010
"url": "git+https://github.com/objectivehtml/flipflock.git"
1111
},
12-
"homepage": "https://github.com/objectivehtml/flipflock#readme",
12+
"homepage": "https://flipclockjs.com",
1313
"bugs": {
1414
"url": "https://github.com/objectivehtml/flipflock/issues"
1515
},

0 commit comments

Comments
 (0)