Skip to content

Commit

Permalink
remove spec bundle, add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jjurman committed Sep 10, 2017
1 parent d8976fc commit 930ab4d
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 38 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Tram-One Express

Tram-One Express is a generator for building tram-one applications.

## Usage
To use tram-one-express, install using npm, and then run the command with the name of the app you want to build:
```
$ npm install -g tram-one-express
$ tram-one-express app-name
```
This will create a directory in your current directory with the name that you pass into tram-one-express.

## What's in the box
Below are a list of files and directories that are created after running tram-one-express
```
app-name/
├── README.md
├── elements
│ └── header.js
├── main.js
├── package.json
├── pages
│ ├── 404.js
│ └── home.js
├── public
│ ├── favicon.png
│ └── index.html
└── specs
├── header-spec.js
├── specs.js
├── testem.html
└── testem.yml
```

## Developement Commands
Below are a list of commands used for developement. The logic for all the commands are in the local `package.json`
- `npm start` - creates an example app `tram-one-example`
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"generator"
],
"scripts": {
"start": "node generator tram-one-example",
"start": "node generator.js tram-one-example",
"poststart": "npm --prefix ./tram-one-example install ./tram-one-example",
"example-start": "npm --prefix ./tram-one-example start",
"example-test": "npm --prefix ./tram-one-example test"
Expand Down
3 changes: 3 additions & 0 deletions template/.gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Distributable
dist

# Files built when testing
specs/spec-bundle.js

# Logs
logs
*.log
Expand Down
Loading

0 comments on commit 930ab4d

Please sign in to comment.