Skip to content

Commit 0d617e9

Browse files
authored
Merge pull request #12 from chkware/docs/readme-details
docs: add details about sharing and
2 parents f6a0183 + 2cb2f43 commit 0d617e9

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
1-
# chkware.github.io
1+
# `chkware` website
22

3-
Web portal for chkware. Built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
3+
This repository holds source code and publishable website for [**`chkware`**](https://github.com/chkware/cli#readme). Please access using https://chkware.github.io
44

5-
### Installation
5+
6+
### Installation [TBD]
67

78
```
89
$ npm install
910
```
1011

11-
### Local Development
12+
### Local Development [TBD]
1213

1314
```
1415
$ npm start
1516
```
1617

1718
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1819

19-
### Build
20+
### Build [TBD]
2021

2122
```
2223
$ npm run build
2324
```
2425

2526
This command generates static content into the `build` directory and can be served using any static contents hosting service.
27+
28+
### Status
29+
30+
The current status of the website is **under construction**. Please follow us on Twitter [@chkware](https://twitter.com/chkware) for update. Thank you for your patience.
31+
32+
---
33+
`chkware` website uses [docusaurus v2.0.0-beta.17](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-beta.17) as CMS backend.

0 commit comments

Comments
 (0)