Skip to content
This repository has been archived by the owner on Nov 3, 2021. It is now read-only.

Commit

Permalink
Merge pull request #24 from twitter-fabric/release-1.0.1
Browse files Browse the repository at this point in the history
Release bump for v1.0.1
  • Loading branch information
fionawhim committed Oct 5, 2015
2 parents 6fb1d55 + 8b47081 commit ac502a9
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 4 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### v1.0.1 (2015-10-05):

#### Bug fixes
* Shims out Velocity when running on the server so that the components all no-op

### v1.0.0 (2015-09-29):

Initial release! Contains `VelocityComponent` and `VelocityTransitionGroup`.

Read the [blog post](https://fabric.io/blog/introducing-the-velocityreact-library) and
enjoy the demos.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
Read our [announcement blog post](https://fabric.io/blog/introducing-the-velocityreact-library) for
details about why and how we built this.

**Latest version:** 1.0.1 shims out Velocity to be compatible with server-side rendering

## Running the demo

```
Expand Down Expand Up @@ -34,8 +36,8 @@ utilities, are distributed as ES5-compatible JavaScript files with [CommonJS](ht
This package depends directly on Velocity, as well as [lodash](https://lodash.com/) for a handful
of utility functions (which are required individually to try and keep bundle size down).

It is assumed that your application already depends on React. The `VelocityTransitionGroup`
component particularly requires the React addons at version 0.13 or higher.
It is assumed that your application already depends on React 0.13. Support for React 0.14
release candidates is coming soon.

## Usage

Expand Down Expand Up @@ -146,9 +148,21 @@ You will need to manually register the UI Pack with the global Velocity in your

See: http://julian.com/research/velocity/#uiPack

### Server-side rendering

The `VelocityComponent` and `VelocityTransitionGroup` components are (as of v1.0.1) not
incompatible with rendering on the server. At this stage, the components will just no-op
and let the children render naturally. If your initial animation end states match
natural rendering anyway this will be exactly what you want. Otherwise you may notice a
flash when the JS is applied and the initial animations are resolved.

## Bugs
Please report any bugs to: <https://github.com/twitter-fabric/velocity-react/issues>

**We welcome contributions!** Note that when testing local changes against local projects you’ll
need to avoid `npm link` since it typically will cause duplicate instances of `React` in the client.
(You’ll often see this manifest as `firstChild undefined` errors.)

## Acknowledgments
Thanks to Julian Shapiro and Ken Wheeler for creating and maintaining Velocity, respectively,
and for working with us to release this library.
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "velocity-react",
"version": "1.0.0",
"version": "1.0.1",
"description": "React components to wrap Velocity animations",
"main": "index.js",
"scripts": {
Expand All @@ -26,7 +26,7 @@
"velocity-animate": "^1.2.3"
},
"peerDependencies": {
"react": ">=0.13.0"
"react": "^0.13.0"
},
"devDependencies": {
"babel-core": "^5.8.25",
Expand Down

0 comments on commit ac502a9

Please sign in to comment.