diff --git a/README.md b/README.md index 242cb12..2de1687 100644 --- a/README.md +++ b/README.md @@ -1,116 +1,49 @@ -# AngularJS-Boilerplate -Simple AngularJS Boilerplate to kick start your new project with SASS support and Gulp watch/build tasks +# ls-grid +Simple AngularJS grid # Features -* SASS support including sourceMaps -* Minimal CSS styling of the view -* Gulp watch, build and local server tasks -* Responsive navigation -* Owl slider directive -* localStorage service for set, get, remove data -* queryService $http wrapper to handle calls -* clear folder structure -* less than 10 request in build version -* minified CSS and JS build files -* google analytics snippet +* Data array or dataUrl is only required config to start! +* Headers can be auto created +* Sort by every column +* Bottom toolbar with info and pagination +* Clear folder structure -## Download -```bash -bower install angularjs-boilerplate -``` - -or - -```bash -git clone https://github.com/jbutko/AngularJS-Boilerplate.git -``` +# Demo +http://wap7.ru/folio/angular-ls-grid/index.html -## 1. Setup -```bash -npm install -``` -- install all npm and bower dependencies +# Documentation -**Note:** If `npm install` fails during dependency installation it will be likely caused by `gulp-imagemin`. In that case remove `gulp-imagemin` dependency from `package.json`, run `npm install` again and then install `gulp-imagemin` separately with following command: `npm install gulp-imagemin --save-dev` +``` +Available options are -## 2. Watch files -```bash -gulp -``` -- all SCSS/HTML will be watched for changes and injected into browser thanks to BrowserSync +data - {Array} +dataUrl - {String} +headers - {Array} +itemsPerPage - {Number}, 20 by default +tableWidth - {css value}, 90% by default -## 3. Build production version -```bash -gulp build -``` -- this will process following tasks: -* clean _build folder -* compile SASS files, minify and uncss compiled css -* copy and optimize images -* minify and copy all HTML files into $templateCache -* build index.html -* minify and copy all JS files -* copy fonts -* show build folder size +Pass options to directive ls-grid -## 4. Start webserver without watch task -```bash -gulp server -``` +$scope.options = { + tableWidth: '40%', + itemsPerPage: 10, + dataUrl: 'api/mydata.json', + headers: {"name": "Name", "start_date": "Start Date", "clicks": "Clicks"} +}; + + -## 5. Start webserver from build folder -```bash -gulp server-build ``` -## Contact -Copyright (C) 2015 Jozef Butko
-[www.jozefbutko.com/resume](http://www.jozefbutko.com/resume)
-[www.github.com/jbutko](http://www.github.com/jbutko)
-[@jozefbutko](http://www.twitter.com/jozefbutko)
-Released under MIT license -## Changelog -### 1.1.7 -- Install all dependencies with 'npm install' (bower included) - pull req #7 by @bbodine1
-15.05.2015 -### 1.1.6 -- Cleaned up the gulpfile with gulp-load-plugins - pull req #6 by @davieschoots
-26.04.2015 -### 1.1.5 -- added MIT License
-19.04.2015 - -### 1.1.4 -- added minification of JS files in build task
-- added favicon
-- gulpfile.js beautify and clean up
-- added owl carousel into demo
-04.04.2015 - -### 1.1.3 -- index.html update: added browserupgrade tag
-- index.html update: http-equiv meta tag, google analytics support
-- comments update in gulpfile.js
-- gulpfile.js formatting
-- pull request #1: removed duplicate gulp require in gulpfile.js
-04.04.2015 - -### 1.1.2 -- package.json and gulpfile.js clean up
-02.04.2015 +# Download +```bash +git clone https://github.com/lev-savranskiy/angular-ls-grid.git -### 1.1.1 -- opened responsive nav fix, css build .min appendix, live demo, github icons
-31.03.2015 +OR -### 1.1.0 -- many improvements: responsive nav, code clean up, gulp angular templateCache -support, gulp task for local server, SASS sourceMaps support
-29.03.2015 +ZIP https://github.com/lev-savranskiy/angular-ls-grid/archive/master.zip +``` -### 1.0.0 -- initial release
-22.03.2015