Skip to content

Commit

Permalink
Bumped version to v0.1.0. README.md edits.
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanh committed Mar 5, 2016
1 parent ace05b0 commit 98028b3
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 19 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

This CHANGELOG follows conventions [outlined here](http://keepachangelog.com/).

## [v0.0.4]
## [v0.1.0]
### Added
- Changed existing unit tests to static tests by @jrwells
- Completed the full unit test suite by @jrwells
Expand All @@ -21,5 +21,5 @@ This CHANGELOG follows conventions [outlined here](http://keepachangelog.com/).
- Babel build configuration and package setup by @jrhusney
- Initial documentation by @jrhusney

[v0.0.4]: https://github.com/ParabolInc/falcor-saddle/compare/v0.0.3...v0.0.4
[v0.0.4]: https://github.com/ParabolInc/falcor-saddle/compare/v0.0.3...v0.1.0
[v0.0.3]: https://github.com/ParabolInc/falcor-saddle/compare/v0.0.1...v0.0.3
25 changes: 10 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
# falcor-saddle

Experimental model route scaffold generation for
[Falcor](https://netflix.github.io/falcor/)*giddyup!*
Experimental model route generation for
[Netflix Falcor](https://netflix.github.io/falcor/)*giddyup!*

## Overview

Netflix Falcor is a library for efficiently querying data across a network.
It presents some useful solutions for querying data from multiple datasources,
caching, and batching queries for greater performance.
caching, and batching queries for greater performance. Yet, getting Falcor
wired up to a back-end model can take _a lot_ of repetitive code.

`falcor-saddle` is an experimental module that will generate CRUD-like
routes given a set of model methods.

While wiring up
[Falcor routes](http://netflix.github.io/falcor/documentation/router.html)
on the server, we found we were writing a lot of similar code. We rolled up
these patterns into a module I called `falcor-saddle`. The model methods tend
to be simpler than writing the route implementations by hand.
`falcor-saddle` is a module that will generate CRUD-like routes for you if
you give it a set of methods for accessing your model.

Instead of writing this:

Expand All @@ -27,26 +22,26 @@ const routes = {
{
route: "todos.length",
get: (pathSet) => {
/* implementation */
/* repetitive implementation */
}
},
{
route: "todos[ranges]",
get: (pathSet) => {
/* more implementation */
/* more repetitive implementation */
}
},
{
route: "todosById[keys]",
get: (pathSet) => {
/* yet more implementation */
/* yet more repetitive implementation */
}
},
/* plus routes to set, create, and delete todos... */
}
```

You can write this:
You can write this instead:

```javascript
import Todo from 'model-todo';
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "falcor-saddle",
"version": "0.0.4",
"description": "Experimental model route scaffolding for Netflix Falcor – giddyup!",
"version": "0.1.0",
"description": "Experimental model route generation for Netflix Falcor – giddyup!",
"main": "lib/index.js",
"files": [
"lib/",
Expand Down

0 comments on commit 98028b3

Please sign in to comment.