Permalink
Browse files

Added changelog and updated readme and meta files for 2.0.0 release

  • Loading branch information...
1 parent 6b592df commit a64209c4248d5762d0bb7cf41ed28469af51bcb5 @IanLunn committed Aug 9, 2015
Showing with 75 additions and 64 deletions.
  1. +5 −0 CHANGELOG.md
  2. +25 −30 CONTRIBUTING.md
  3. +39 −20 README.md
  4. +3 −7 bower.json
  5. +1 −1 index.html
  6. +2 −6 package.json
View
@@ -0,0 +1,5 @@
+# Change Log
+
+## 2.0.0 (2015/08/09)
+
+- Built from ground-up
View
@@ -12,19 +12,19 @@ The following gives a brief description for each file's purpose.
### `css`
-Contains stylesheets for the demo theme and demo overlay.
+Contains stylesheets for the demo page and intro theme.
### `scripts`
Contains the compiled `sequence.js` and its minified version `sequence.min.js`. If you want to develop `sequence.js` please do so in the version found in `src`. Also contains the following third-party dependencies:
- `hammer.min.js` - Used for touch support
- `imagesloaded.pkgd.min.js` - Used for preloading images
-- `sequence-theme.basic.js` - Options and inititation code to start Sequence on the demo theme
+- `sequence-theme.intro.js` - Options and inititation code to start Sequence.js on the Intro theme.
### `src`
-Contains the development version of `sequence.js`. This is the file to change should you wish to work on the core Sequence library.
+Contains the development version of `sequence.js`. This is the file to change should you wish to work on the core Sequence.js library.
### `tests`
@@ -36,86 +36,85 @@ Lists files/directory that [Git](http://git-scm.com/) should ignore.
### `bower.json`
-Lists Sequence's [Bower](http://bower.io/) details and the dependencies it uses.
+Lists Sequence.js' [Bower](http://bower.io/) details and the dependencies it uses.
### `CHANGELOG.md`
-Contains history of all the changes made to Sequence.
+Contains history of all the changes made to Sequence.js.
### `CONTRIBUTING.md`
The very file you are reading right now!
-### `DOCUMENTATION.md`
-
-Contains everything you need to know about working with Sequence.
-
### `Gruntfile.js`
-Describes the automated tasks used for developing Sequence.
+Describes the automated tasks used for developing Sequence.js.
### `index.html`
-The demo theme for Sequence.
+The Intro theme for Sequence.js.
### `LICENSE.md`
-License information for Sequence.
+License information for Sequence.js.
### `package.json`
-Lists Sequence's [NPM](https://www.npmjs.org/) details and the dependencies it uses during development.
+Lists Sequence.js' [NPM](https://www.npmjs.org/) details and the dependencies it uses during development.
### `README.md`
-The intro to Sequence.
+The intro to Sequence.js.
## Using Grunt
-The Sequence project uses [Grunt](http://gruntjs.com/) to automate useful tasks. With Grunt installed (see Grunt's [Getting Started](http://gruntjs.com/getting-started)), use the following command to install Sequence's project dependencies:
+The Sequence.js project uses [Grunt](http://gruntjs.com/) to automate useful tasks. With Grunt installed (see Grunt's [Getting Started](http://gruntjs.com/getting-started)), use the following command to install Sequence.js' project dependencies:
```
npm install
```
-Once Sequence's project dependencies have installed you can use the commands `grunt`, `grunt run`, `grunt jshint`.
+Once Sequence.js dependencies have installed you can use the commands `grunt`, `grunt serve`, `grunt test`, and `grunt test-watch`.
### `grunt`
-This is the default command that will start a development environment with the following automated tasks:
+This will manually run the tasks run via the `grunt serve` command once.
+
+### `grunt serve`
+
+This will start a development environment with the following automated tasks:
- Starts a [livereload](http://livereload.com/) session that will reload your browser whenever a file is changed (be sure to install [livereload](http://livereload.com/))
- Opens your browser and navigates to `http://localhost:8000/`
- Sets up a *watch* task to run the following sub-tasks:
- Update the version number in `sequence.js` and `bower.json` when changed in `package.json`
- Copy `src/sequence.js` to the `scripts` directory and create an uglify (minified) copy as `scripts/sequence.min.js`
- - Process any `.scss` files found in the `scss` directory, autoprefix them and then copy to `css` and minify
+ - Process any `.scss` files found in the `scss` directory then copy to `css` and minify
-You only need to run `grunt` per each development session as the *watch* task will continue to operate as you modify files.
+You only need to run `grunt serve` per each development session as the *watch* task will continue to operate as you modify files.
-### `grunt run`
+### `grunt test`
-The `grunt run` command is a manual version of the *watch* sub tasks listed for the `grunt` command.
+Manually runs [JSHint](http://www.jshint.com/about/) and Sequence.js tests via jasmine and karma.
-### `grunt jshint`
+### `grunt test-watch`
-The `grunt jshint` command will run a command line version of [JSHint](http://www.jshint.com/about/) that suggests improvements that can be made in `src/sequence.js`.
+Runs the same tests as the `grunt test` command each time the files in `tests/` are updated.
## Submitting a Bug
-Please note that the issue tracker is for bugs only -- either relating to sequence.js, its dependencies, or official Sequence themes. For support on your own Sequence themes, please use [StackOverflow](http://stackoverflow.com/questions/ask?tags=sequence|sequencejs) with the tags `sequence` and/or `sequencejs`.
+Please note that the issue tracker is for bugs only -- either relating to sequence.js, its dependencies, or official Sequence.js themes. For support on your own Sequence.js themes, please use [StackOverflow](http://stackoverflow.com/questions/ask?tags=sequencejs) with the tag `sequencejs`.
### Before reporting a bug
1. Search [issue tracker](https://github.com/IanLunn/Sequence/issues) for similar issues.
-2. Try the latest [dev branch](https://github.com/IanLunn/Sequence/tree/dev) version of sequence.js.
### How to report a bug
1. Specify the version number of the sequence.js library where the bug occurred (you'll find it toward the top of `sequence.js`, `sequence.min.js`, or `package.json`).
2. Specify your browser version and operating system (for example, Chrome 35, Windows 8)
3. Describe the problem in detail. Explain what happened, and what you expected would happen.
-4. Provide a small test-case via [CodePen](http://codepen.io/), [JSBin](http://jsbin.com/), [JSFiddle](http://jsfiddle.net/), or similar. If a test-case is not possible, provide a link to a live version of your application.
+4. Provide a [reduced test-case](https://css-tricks.com/reduced-test-cases/) via [CodePen](http://codepen.io/), [JSBin](http://jsbin.com/), [JSFiddle](http://jsfiddle.net/), or similar.
5. If helpful, include a screenshot. Annotate the screenshot for clarity.
## Submitting a Pull Request
@@ -124,7 +123,3 @@ Please note that the issue tracker is for bugs only -- either relating to sequen
2. Fork the repository on [GitHub](https://github.com/IanLunn/Sequence).
3. Make changes to your clone of the repository.
4. Submit a pull request.
-
-## Submit Your Theme to The Showcase
-
-If you've created a Sequence theme you'd like the world to see, submit it to our [showcase](https://github.com/IanLunn/Sequence/wiki/Showcase) and it may get featured on the [SequenceJS.com](http://sequencejs.com/) website!
View
@@ -1,42 +1,51 @@
-Sequence.js [![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=IanLunn&url=https://github.com/IanLunn/Sequence&title=Sequence&language=english&tags=github&category=software)
+Sequence.js [![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=IanLunn&url=https://github.com/IanLunn/Sequence&title=Sequence&language=english&tags=github&category=software) [![Join the chat at https://gitter.im/IanLunn/Sequence](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/IanLunn/Sequence?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
=====================
> The responsive CSS animation framework for creating unique sliders, presentations, banners, and other step-based applications.
+Sequence.js provides all of the JavaScript functionality you need for step-based applications such as sliders and presentations, allowing you to concentrate on producing your content with style.
+
+Easily add transitions using the `.seq-in` and `.seq-out` CSS classes automatically added via Sequence.js to style how your slides/steps and content animate.
+
+Find out how Sequence.js works in the [Introduction theme](http://ianlunn.github.io/Sequence/) or for more details, head to the [documentation](http://sequencejs.com/documentation/).
+
## Demos
-See the [introduction](http://ianlunn.github.io/Sequence/) and [ready-made themes](http://sequencejs.com/themes/).
+See the [introduction](http://ianlunn.github.io/Sequence/) and [ready-made themes](http://www.sequencejs.com/themes/).
## Features
-- Create animated themes using CSS transitions
+- Rapid development of animated step-based applications using CSS
- Fully supports responsive design
-- Supported on mobile, tablet and desktop devices
-- No limitations on CSS or HTML you can use
+- Supported on mobile, tablet, and desktop devices
+- No limitations on CSS, HTML, and workflow you can use
- Animate canvas and content
-- Support for 60FPS animations
-- Auto play
-- next/previous/pause buttons and pagination support
+- Hardware acceleration (for smooth animation even on mobile devices)
- Touch support via [Hammer.js](http://eightmedia.github.io/hammer.js/)
+- Auto play
+- Easy-to-add next/previous/pause buttons and pagination
- Preloader via [ImagesLoaded](http://imagesloaded.desandro.com/)
- Hash tag support
- Keyboard navigation
-- API for custom functionality
-- Top quality [documentation](https://github.com/IanLunn/Sequence/wiki/Documentation)
-- Supports all major browsers with a fallback mode for legacy browsers ([detailed browser support](https://github.com/IanLunn/Sequence/wiki/Sequence-v2-Browser-Support))
+- 30+ options and API for custom functionality
+- Top quality [documentation](http://sequencejs.com/documentation/)
+- Supports all major browsers with a fallback mode for legacy browsers ([detailed browser support](http://sequencejs.com/developers/browser-support/))
+- [Ready-made themes](http://sequencejs.com/themes/) available
- [Yeoman generator](https://github.com/IanLunn/generator-sequence) available for quick scaffolding of themes
-## Philosophy
+### Browser Support
+
+Sequence.js is supported in modern browsers on major platforms, with a [fallback theme](http://www.sequencejs.com/documentation/#browser-support-and-fallback-mode) for Internet Explorer 8 and 9, and other older browsers that don't support CSS transitions.
-The key philosophy for Sequence.js is to aid you in creating your animated step-based application without getting in the way of how you or a web browser work. Create content and then animate it using the HTML and CSS you're used to. There's no special syntax to learn, no limitations on the elements you can use, and no heavy JavaScript implementations recreating what the browser is already capable of.
+[See Browser Support in more detail](http://www.sequencejs.com/developers/browser-support/).
## Getting Started
-To get started [download](https://github.com/IanLunn/Sequence#download) Sequence.js and then head to the [documentation](https://github.com/IanLunn/Sequence/wiki/Documentation). If you'd like to contribute to Sequence.js development, please see the [contributing](https://github.com/IanLunn/Sequence/blob/master/contributing.md) guidelines.
+To get started [download](http://sequencejs.com/download/) Sequence.js and then head to the [documentation](http://www.sequencejs.com/documentation/). If you'd like to contribute to Sequence.js development, please see the [contributing guidelines](https://github.com/IanLunn/Sequence/blob/master/CONTRIBUTING.md).
### Download
-- [Download Sequence.js](https://github.com/IanLunn/Sequence/archive/master.zip)
+- [Download Sequence.js](http://sequencejs.com/download/)
Sequence.js can also be installed using the [Bower](http://bower.io/) command:
@@ -50,20 +59,30 @@ or [NPM](https://www.npmjs.org/):
npm install sequencejs
```
+## Philosophy
+
+Sequence.js aims to provide a complete animation framework for you to create animated step-based applications almost entirely in CSS without getting in the way of how you or a web browser work. Create content and then animate it using the HTML, CSS, and workflow you're used to. Sequence.js will take care of the JavaScript functionality. There's no special syntax to learn, no limitations on the workflow you are used to, and no heavy JavaScript implementations recreating what the browser is already capable of.
+
## Authors
-[Ian Lunn](https://ianlunn.co.uk/) and [contributors](https://github.com/IanLunn/Sequence/graphs/contributors).
+[Ian Lunn](http://ianlunn.co.uk/) and [contributors](https://github.com/IanLunn/Sequence/graphs/contributors).
-Follow [@IanLunn](https://twitter.com/IanLunn/) on Twitter for updates on Sequence.js as well as news and opinions on front-end web development.
+Follow [@IanLunn](https://twitter.com/IanLunn/) on Twitter for Sequence.js news, web design & development links, tips, and opinions
## Sponsors
-Sequence.js browser testing environment is provided by <a href="http://browserstack.com/">BrowerStack</a>.
+Browser testing environment provided by <a href="http://browserstack.com/">BrowserStack</a>.
[![Browser Stack](http://www.sequencejs.com/wp-content/themes/sequence/images/browserstack-light.png)](http://browserstack.com/)
-## License
+## Licenses
+
+License information can be found on the [Sequence.js website](http://www.sequencejs.com/licenses/).
+
+## Hire Ian Lunn
+
+[Ian Lunn](http://ianlunn.co.uk) is a Web Designer, Front-end Developer, and author of [CSS3 Foundations](http://css3foundations.com/).
-License information can be found on the [Sequence.js website](http://sequencejs.com/licenses/) or in [LICENSE.md](https://github.com/IanLunn/Sequence/blob/master/LICENSE.md).
+Hire [Ian Lunn](http://ianlunn.co.uk) for responsive design, WordPress sites, HTML, CSS, and JavaScript.
[![Analytics](https://ga-beacon.appspot.com/UA-11991680-6/sequence)](https://github.com/ianlunn/sequence)
View
@@ -4,7 +4,7 @@
"version": "2.0.0",
"main": "scripts/sequence.min.js",
"license": "SEE LICENSE IN LICENSE.md",
- "homepage": "http://sequencejs.com/",
+ "homepage": "http://www.sequencejs.com/",
"repository": {
"type": "git",
"url": "git://github.com/IanLunn/Sequence.git"
@@ -16,11 +16,8 @@
"keywords": [
"sequence",
"sequence.js",
+ "sequencejs",
"slider",
- "css3",
- "slider",
- "carousel",
- "css3",
"carousel",
"animation",
"animation framework",
@@ -36,7 +33,6 @@
],
"dependencies": {
"hammerjs": "2.0.4",
- "imagesloaded": "3.1.5",
- "respond": "^1.4.2"
+ "imagesloaded": "3.1.5"
}
}
View
@@ -674,7 +674,7 @@
</ul>
<p>Made by<br /><a href="http://ianlunn.co.uk/" title="Ian Lunn - Freelance Web Designer &amp; Front End Developer" target="_blank">Ian Lunn - Web Designer &amp; Front End Developer</a></p>
- <p class="follow"><a href="https://twitter.com/IanLunn" class="twitter-follow-button" data-show-count="false" data-dnt="true" data-size="large">Follow @IanLunn</a> for web design &amp; development<br /> links, tips, and opinions</p>
+ <p class="follow"><a href="https://twitter.com/IanLunn" class="twitter-follow-button" data-show-count="false" data-dnt="true" data-size="large">Follow @IanLunn</a> for Sequence.js news, web design &amp; development<br /> links, tips, and opinions</p>
<small>Copyright &copy; 2015 <a href="http://ianlunn.co.uk/" title="Ian Lunn - Freelance Web Designer &amp; Front End Developer" target="_blank">Ian Lunn Design Limited</a></small>
</div>
</div>
View
@@ -5,7 +5,7 @@
"main": "scripts/sequence.min.js",
"license": "SEE LICENSE IN LICENSE.md",
"author": "Ian Lunn",
- "homepage": "https://github.com/IanLunn/Sequence",
+ "homepage": "http://www.sequencejs.com/",
"bugs": "https://github.com/IanLunn/Sequence/issues",
"repository": {
"type": "git",
@@ -14,12 +14,8 @@
"keywords": [
"sequence",
"sequence.js",
- "seq",
+ "sequencejs",
"slider",
- "css3",
- "slider",
- "carousel",
- "css3",
"carousel",
"animation",
"animation framework",

0 comments on commit a64209c

Please sign in to comment.