Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kvz committed Jan 17, 2014
1 parent f423aa1 commit 5e58119
Show file tree
Hide file tree
Showing 6 changed files with 153 additions and 150 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
npm-debug.log
tools/_temp/*
_octopress/_deploy
nbproject
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ npm:
node build/npm.js
echo "Build success. "

publish: npm
npm publish

build: npm

hook:
Expand Down
33 changes: 4 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,32 +12,7 @@ php.js is a resource that offers community-built JavaScript alternatives to PHP

More info at: http://phpjs.org/about

# Building the site

## Prerequisites

The site is built using Octopress. For instructions how to set things up,
please check [here](http://kvz.io/blog/2012/09/25/blog-with-octopress/).

## build, generate, commit, push, deploy

```shell
make site MSG="Updated site"
```

## preview locally

```shell
make site-preview
```

## reset site (should not be necessary)

```shell
make site-clean
```

# Npm
## Npm

```bash
$ npm install phpjs
Expand All @@ -54,10 +29,10 @@ $ node test.js
Hey you
```

# Testing
## Testing


# Cli
### cli

```bash
make test
Expand All @@ -68,7 +43,7 @@ node bin/phpjs.js --action test --name sort
node bin/phpjs.js --action test --category array
```

# Web
### Web

```bash
PORT=8080 node _tests/server.js
Expand Down
24 changes: 24 additions & 0 deletions Site.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Building the site

## Prerequisites

The site is built using Octopress. For instructions how to set things up,
please check [here](http://kvz.io/blog/2012/09/25/blog-with-octopress/).

## build, generate, commit, push, deploy

```shell
make site MSG="Updated site"
```

## preview locally

```shell
make site-preview
```

## reset site (should not be necessary)

```shell
make site-clean
```

0 comments on commit 5e58119

Please sign in to comment.