add README

Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
Jakub Sokołowski 2020-09-23 12:50:57 +02:00
parent 95a91eeecd
commit 67d92d83b9
No known key found for this signature in database
GPG Key ID: 4EF064D0E6D63020
1 changed files with 38 additions and 1 deletions

View File

@ -1 +1,38 @@
# our-status
# Description
This is the Ghost theme used for https://our.status.im/.
# Usage
Install the dependencies:
```
yarn install
```
To verify the theme is valid use:
```
yarn verify
```
To pack up the theme use:
```
yarn archive
```
# CSS
We just fetch CSS from tha main site:
```
yarn getcss
```
The updates to tempaltes need to be manual.
# Development
You can start a local instance of Ghost using:
```
yarn ghost-install
```
Which will start a ghost instance at: http://localhost:2368/
It should use the current state of this repo as its theme.
The instance will be installed at `/var/tmp/ghost`.
It will have this repo symlinked under `content/themes/casper`.