Skip to content
This repository has been archived by the owner on Feb 11, 2022. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Andreas Eldh committed Feb 27, 2015
1 parent 1b4ec3f commit 1f2b4ab
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,39 @@
# Antwar

[![Join the chat at https://gitter.im/eldh/antwar](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/eldh/antwar?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

A static site generator using [React](https://github.com/facebook/react).

Very much alpha.

## Installation
### Installation
After cloning this repo run `npm install`.

## Run in dev mode
### Run in dev mode
`gulp`

## Add a new post
### Add a new post
Add .md file in `posts/` directory

## Add a new page
### Add a new page
Add a .js/.jsx/.coffee file in `/pages` directory

## Build for production
### Build for production
`gulp build`

## Run production server
### Run production server
`gulp publicServer`

## TODO

Among many other things:

- Proper basic theme
- Drafts
- A proper dev index file
- A better api
- A nice way to include non-static parts

## Contributions
All contributions are welcome. Please open an issue if you have an idea. :)

##Credits
This is based on the fantastic work of [Brad Denver](https://github.com/BradDenver/react-static-site).

0 comments on commit 1f2b4ab

Please sign in to comment.