0.0.2 • Published 9 years ago

trendsetter v0.0.2

Weekly downloads
4
License
ISC
Repository
github
Last release
9 years ago

Trendsetter

Build Status

Trendsetter is a Node.js package for generating beautiful interactive styleguides with ease.

Front-end frameworks like Bootstrap and Foundation are awesome. The most awesome feature of these frameworks is not their plethora of shiny components but instead their thorough documentation. Having extensive front-end documentation helps prevent developers from writing redundant code, makes it easier to on-board new developers to a project, and ensures better communication between front-end and back-end devs.

As awesome as front-end frameworks are, sometimes you just want to roll your own and that's where Trendsetter comes in. Trendsetter will parse your stylesheets for comments and automatically create beautiful documentation.

##Getting Started

There are a number of different ways you can integrate Trendsetter into a project:

  1. Install gulp-trendsetter and integrate with Gulp (recommended)
  2. OR install the Trendsetter Node package
  3. OR install Trendsetter globally and run from the command line
  4. OR install Trendsetter via Bower

##Roadmap

  • integrate Mocha and Chai and write tests for exisiting code (revise tests)
  • intergrate with Travis CI and display "build passing" in repo readme
  • setup Angular Trendsetter user interface