Skip to content

Commit

Permalink
fix(docs) add clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasgazzoni committed Oct 27, 2017
1 parent 1d53801 commit 2712ddd
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ npm install rxjs-ddp-client

## Usage Exemple

- First you need to create a custom DDPClient that will extend from the base class DDPClient (for example my-ddp-client.ts).
- In this custom DDPClient class you need to implement your DDP app logic (Collections names, DDP server url, etc)
- First you need to create a custom DDPClient class that will extend from the base class DDPClient (for example the below file my-ddp-client.ts).
- In this custom DDPClient class you need to implement all your DDP app logic (Login, Collections names, DDP server url, etc)

```ts
// my-ddp-client.ts
Expand Down Expand Up @@ -139,8 +139,8 @@ export class MyDDPClient extends DDPClient {
}
```

- rxjs-ddp-client comes with cache out of the box. To keep things flexible, you can use any cache system by implementing a class that has the methods required by ***DDPCacheEngine***.
For example if you chose to use LocalStorage you need a class like this:
- rxjs-ddp-client comes with the data cache out of the box. To keep things flexible, you can use any cache system by implementing a class that has the methods required by ***DDPCacheEngine*** interface.
For example if you chose to use LocalStorage as cache engine you need a class like this:

```ts
// my-ddp-cache-engine.ts
Expand Down Expand Up @@ -174,7 +174,7 @@ export class MyDDPCacheEngine implements DDPCacheEngine {

```

- Ultimatly you can initialize your custom DDP client in your app main entry point
- Ultimately you can initialize your custom DDP client in your app main entry point


VanillaJS
Expand Down Expand Up @@ -234,7 +234,7 @@ export class AppComponent {
```

## Todos
## Todo
- Write more tests scenarios

## Thanks
Expand Down

0 comments on commit 2712ddd

Please sign in to comment.