diff --git a/.npmignore b/.npmignore index b40e919..fa37f81 100644 --- a/.npmignore +++ b/.npmignore @@ -1,4 +1,7 @@ +.eslintrc .travis.yml +CHANGELOG.md +demo.png examples -LICENSE +README.md test diff --git a/CHANGELOG.md b/CHANGELOG.md index 21ce291..ff5ccd5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,67 +1,15 @@ -# React Resolver Changelog +# React Resolver Csp Changelog -### Upcoming... +### v0.0.3 (2015-06-07) -- [Error Handling](https://github.com/ericclemmons/react-resolver/issues/2) -- [React Native](https://github.com/ericclemmons/react-resolver/issues/18) +- renamed js-csp so (hopefully) the whole lot will get published to npm +### v0.0.2 (2015-06-07) -### v1.0.0 - (2015-04-13) +- Includes decorators & exports csp -- Complete rewrite for React v0.13 -- "Higher-order Components" via `Resolver.createContainer` -- Remove all dependencies (!) - + [#9](https://github.com/ericclemmons/react-resolver/issues/9) - + [#14](https://github.com/ericclemmons/react-resolver/issues/14) - + [#15](https://github.com/ericclemmons/react-resolver/issues/15) +### v0.0.1 (2015-06-06) -### v0.2.0 - (2015-02-25) +- Initial version -- Remove [`resolver.handle`][11] - - -### v0.1.2 (2015-02-25) - -- Fix [examples/contacts](https://github.com/ericclemmons/react-resolver/tree/e026a3b1cbf16995c10c825c18d2f20b6277f62f/examples/contacts) - - -### v0.1.1 (2015-02-25) - -- Move `react-router` from `optionalDependencies` to `peerDependencies` - - -### v0.1.0 (2015-02-24) - -- [#7][7] - Add `react` and `react-router` as `peerDependencies`. -- [#8][8] - Support React v0.13 - - -### v0.0.4 (2015-02-24) - -- [#4][4] - NPM package is ES5, not ES6. -- [#5][5] - Clarify use of `Resolver.mixin`. -- [#6][6] - README comparison to Relay. - - -### v0.0.3 (2015-02-19) - -- Public release - - -### v0.0.2 (2015-02-18) - -- Working prototype with context - - -### v0.0.1 (2015-01-29) - -- Initial commit - - -[4]: https://github.com/ericclemmons/react-resolver/pull/4 -[5]: https://github.com/ericclemmons/react-resolver/issues/5 -[6]: https://github.com/ericclemmons/react-resolver/issues/6 -[7]: https://github.com/ericclemmons/react-resolver/issues/7 -[8]: https://github.com/ericclemmons/react-resolver/issues/8 -[11]: https://github.com/ericclemmons/react-resolver/issues/11 diff --git a/LICENSE b/LICENSE index c33bc6b..e8bc73c 100644 --- a/LICENSE +++ b/LICENSE @@ -2,9 +2,10 @@ Internet Systems Consortium license =================================== Copyright (c) 2015 Eric Clemmons +Copyright (c) 2015 Giles Bradshaw Permission to use, copy, modify, and/or distribute this software for any purpose -with or without fee is hereby granted, provided that the above copyright notice +with or without fee is hereby granted, provided that the above copyright notices and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH diff --git a/Original LICENSE b/Original LICENSE new file mode 100644 index 0000000..c33bc6b --- /dev/null +++ b/Original LICENSE @@ -0,0 +1,16 @@ +Internet Systems Consortium license +=================================== + +Copyright (c) 2015 Eric Clemmons + +Permission to use, copy, modify, and/or distribute this software for any purpose +with or without fee is hereby granted, provided that the above copyright notice +and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS +OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER +TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF +THIS SOFTWARE. diff --git a/README.md b/README.md index 24b3c96..fea36e9 100644 --- a/README.md +++ b/README.md @@ -1,136 +1,85 @@ -# React Resolver  - -> Isomorphic library to lazy-load data for React components - -[](https://github.com/ericclemmons/react-resolver/issues) -[](https://travis-ci.org/ericclemmons/react-resolver) -[](https://david-dm.org/ericclemmons/react-resolver#info=dependencies) -[](https://david-dm.org/ericclemmons/react-resolver#info=devDependencies) - - -## Features - -- **Promise-based** – Define & lazy-load component data dependencies and inject them as `props`. -- **Isomorphic** – Express/Koa/Hapi-friendly server-side rendering & progressive, client-side rendering. -- **Test friendly** – Containers promote separation between data-fetching & rendering. - - -## Demo - -> [][demo] - -[View Demo][demo] - - -- - - - - -- [Features](#features) -- [Demo](#demo) -- [Requirements](#requirements) -- [Installation](#installation) -- [Usage](#usage) - + [Client](#client) - + [Server](#server) -- [Changelog][changelog] -- [Development](#development) -- [Authors](#authors) -- [License][license] - -- - - - - -## Requirements - -- React `v0.13.x` - -_For browsers that don't nativeuly support promises, use [ES6 Promise](https://github.com/jakearchibald/es6-promise)._ - - -## Installation - -```shell -npm install --save react-resolver -``` - -- - - - -## Usage - -_Example is based on [Stargazers.js](https://github.com/ericclemmons/react-resolver/blob/master/examples/stargazers/components/Stargazers.js) in the [demo][demo]._ - -Suppose you want to display list of users, but that data is loaded -asynchronously via an API. - -Rather than having your component handle data-fetching _and_ rendering, -you can create a "container" that fetches the data and only renders when ready: - -```javascript -import React from "react"; -import { Resolver } from "react-resolver"; - -class Users extends React.Component { - render() { - return ( -
+ {user.company}
+
+ {user.location}
+