diff --git a/readme.md b/readme.md index c27799f..8f9be4f 100644 --- a/readme.md +++ b/readme.md @@ -1,27 +1,25 @@ # 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 @@ -29,9 +27,13 @@ Add a .js/.jsx/.coffee file in `/pages` directory 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).