Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lint & Update README.md #155

Merged
merged 2 commits into from
Apr 29, 2022
Merged

Lint & Update README.md #155

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8eed4a8
Lint & Update README.md
corentinleberre Jan 22, 2022
2090045
Merge branch 'master' into patch-1
SimonMcKinsey Apr 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Usage:

```ts
import { Component, ChangeDetectionStrategy } from '@angular/core';
import { store } from './store/counter';

@Component({
changeDetection: ChangeDetectionStrategy.OnPush,
Expand Down Expand Up @@ -140,9 +141,7 @@ import { comparer } from 'mobx';
{{ store.value }} - {{ store.computedValue }}
<button (click)="store.action">Action</button>
</div>
<div
*mobxReaction="getParity.bind(this); options: { name: 'parity reaction', equals: comparer.shallow }"
>
<div *mobxReaction="getParity.bind(this); options: { name: 'parity reaction', equals: comparer.shallow }">
{{ parity }}
</div>
`
Expand Down Expand Up @@ -263,7 +262,7 @@ See the `projects` folder, specifically these files:

To run the examples, clone this repo and run:

```
```shell
$ npm install -g @angular/cli
$ npm install
$ npm run build
Expand All @@ -278,4 +277,3 @@ Important things to always consider when changing code in this library:
- Keep backwards compatibility. Don't force users to refactor their code, even if it means adding a new API instead of changing an exsiting one.
- Keep SEMVER. If breaking changes is unavoidable - increase a major version. New features, however small should increase a minor version, and patch is for bugfixes/performance/refactoring
- Think about bundle size and speed