Skip to content

Commit

Permalink
framework -> library
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronlademann-wf committed Oct 21, 2016
1 parent 9d51a89 commit 99d980d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Test Coverage](https://codecov.io/github/Workiva/over_react/coverage.svg?branch=master)](https://codecov.io/github/Workiva/over_react?branch=master)
[![Documentation](https://img.shields.io/badge/Documentation-over__react-blue.svg)](https://workiva.github.io/over_react)

> A framework for building statically-typed React UI components using Dart.
> A library for building statically-typed React UI components using Dart.

* __[Using it in your project](#using-it-in-your-project)__
Expand Down Expand Up @@ -134,10 +134,10 @@ __you must run your tests using Pub__.
> Since OverReact is built atop React JS, we strongly encourage you to gain
> familiarity with it by reading this [React JS tutorial][react-js-tutorial] first.

The `over_react` framework functions as an additional "layer" atop the [Dart react package][react-dart]
The `over_react` library functions as an additional "layer" atop the [Dart react package][react-dart]
which handles the underlying JS interop that wraps around [React JS][react-js].

The framework strives to maintain a 1:1 relationship with the React JS component class and API.
The library strives to maintain a 1:1 relationship with the React JS component class and API.
To do that, an OverReact component is comprised of four core pieces that are each wired up to our
Pub transformer using an analogous [annotation].

Expand Down
6 changes: 3 additions & 3 deletions lib/src/transformer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ much cleaner and more _grokkable_.

## Wiring it all up

__Be sure to familiarize yourself with the [OverReact framework] first.__
__Be sure to familiarize yourself with the [OverReact library] first.__

The transformer wires up your factory, props class, and component class so that you don't have to!

Expand Down Expand Up @@ -227,7 +227,7 @@ __The easiest way to view it:__



[OverReact framework]: https://github.com/Workiva/over_react/blob/master/README.md
[OverReact library]: https://github.com/Workiva/over_react/blob/master/README.md
[annotations]: https://github.com/Workiva/over_react/blob/master/lib/src/component_declaration/annotations.dart
[component demos]: https://workiva.github.io/over_react/demos
[component demos]: https://workiva.github.io/over_react/demos/
[react-dart]: https://github.com/cleandart/react-dart
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: over_react
publish_to: https://pub.workiva.org
version: 1.0.0
description:
description: A library for building statically-typed React UI components using Dart.
homepage: https://github.com/Workiva/over_react/
authors:
- Workiva UI Platform Team <uip@workiva.com>
Expand Down

0 comments on commit 99d980d

Please sign in to comment.