Skip to content

Commit

Permalink
thelma->lenses
Browse files Browse the repository at this point in the history
  • Loading branch information
sepans committed May 21, 2015
1 parent ce1e06a commit e720f40
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 21 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
# Yeoman generator for Thelma components
# Yeoman generator for Lenses components

## Introduction

Thelma web components are built using the [Polymer](http://www.polymer-project.org/) library. The project allows developers to retrieve, manipulate and visualize data by chaining these components together.
Lenses web components are built using the [Polymer](http://www.polymer-project.org/) library. The project allows developers to retrieve, manipulate and visualize data by chaining these components together.

`generator-thelma` provides Thelma component scaffolding using [Yeoman](http://yeoman.io) (a scaffolding tool for the web), letting you easily create and customize Thelma (custom) elements via the command-line and import them using HTML Imports. This saves you time writing boilerplate code so you can start writing up the logic to your components straight away.
`generator-lenses` provides Lenses component scaffolding using [Yeoman](http://yeoman.io) (a scaffolding tool for the web), letting you easily create and customize Lenses (custom) elements via the command-line and import them using HTML Imports. This saves you time writing boilerplate code so you can start writing up the logic to your components straight away.

## Features
* Sub-generator to create Thelma elements for your app
* Sub-generator to create Lenses elements for your app
* Quick deploy to GitHub pages

## Installation

Install the generator
`npm install -g generator-thelma`
`npm install -g generator-lenses`

Make a new directory and cd into it
`mkdir -p my-project && cd $_`

Generate a new Thelma component:
`yo thelma:seed [element-name]`
Generate a new Lenses component:
`yo lenses:seed [element-name]`

## Generators

Available generators:

- [thelma:lenses](#lenses)
- [thelma:seed](#seed)
- [thelma:gh](#gh)
- [lenses:lenses](#lenses)
- [lenses:seed](#seed)
- [lenses:gh](#gh)

### Lenses
Generates the Lens Composer and the components that can be used with Lenses. Coming soon.

### Seed
Generates a reusable Thelma element.
Generates a reusable Lenses element.

The seed-element generator will construct a new element _and_ its directory for
you. Be aware: all bower dependencies will be installed as _siblings_ of the
Expand All @@ -43,7 +43,7 @@ directory that is intended to contain multiple components!
Example:
```bash
mkdir -p components && cd $_
yo thelma:seed my-element
yo lenses:seed my-element
```

### Gh
Expand All @@ -52,7 +52,7 @@ Generates a Github pages branch for your [seed-element](#seed).
Example:
```bash
cd components/my-element
yo thelma:gh
yo lenses:gh
```

## Contribute
Expand Down
17 changes: 9 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": "generator-thelma",
"name": "generator-lenses",
"version": "0.0.4",
"description": "Yeoman generator for Thelma web components",
"description": "Yeoman generator for Lenses web components",
"license": "MIT",
"main": "app/index.js",
"repository": {
"type": "git",
"url": "git://github.com/lenses/generator-thelma.git"
"url": "git://github.com/lenses/generator-lenses.git"
},
"author": {
"name": "Thelma Team",
"email": "",
"url": "https://github.com/thelmanews"
"name": "Lenses Team",
"email": "[email protected]",
"url": "https://github.com/lenses"
},
"engines": {
"node": ">=0.10.0"
Expand All @@ -21,8 +21,9 @@
},
"keywords": [
"yeoman-generator",
"thelma",
"components",
"data visualization",
"web components",
"polymer",
"lenses"
],
"dependencies": {
Expand Down

0 comments on commit e720f40

Please sign in to comment.