Skip to content

Commit

Permalink
fix(README): changes links to @casl/ability to point to npm package i…
Browse files Browse the repository at this point in the history
…nstead to git root [skip ci]

Fixes #102
  • Loading branch information
stalniy committed Aug 18, 2018
1 parent 20633c8 commit a74086b
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 12 deletions.
3 changes: 2 additions & 1 deletion packages/casl-ability/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ function toMongoQuery(ability, subject, action = 'read') {
const query = toMongoQuery(ability, 'Post')
```

[@casl/mongoose](/packages/casl-mongoose) uses `rulesToQuery` function to construct queries to MongoDB database.
[@casl/mongoose][casl-mongoose] uses `rulesToQuery` function to construct queries to MongoDB database.

See [Storing Abilities][storing-abilities] for details.

Expand Down Expand Up @@ -236,3 +236,4 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! R
[storing-abilities]: https://stalniy.github.io/casl/abilities/storage/2017/07/22/storing-abilities.html
[store-rules]: https://stalniy.github.io/casl/abilities/storage/2017/07/22/storing-abilities.html#storing-abilities
[cache-rules]: https://stalniy.github.io/casl/abilities/storage/2017/07/22/storing-abilities.html#caching-abilities
[casl-mongoose]: http://npmjs.com/package/@casl/mongoose
5 changes: 3 additions & 2 deletions packages/casl-angular/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CASL Angular [![@casl/angular NPM version](https://badge.fury.io/js/%40casl%2Fangular.svg)](https://badge.fury.io/js/%40casl%2Fangular) [![CASL Documentation](https://img.shields.io/badge/documentation-available-brightgreen.svg)](https://stalniy.github.io/casl/) [![CASL Join the chat at https://gitter.im/stalniy-casl/casl](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/stalniy-casl/casl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This package allows to integrate [@casl/ability](/packages/casl-ability) into [Angular][angular] application. So, you can show or hide some components, buttons, etc based on user ability to see them.
This package allows to integrate [@casl/ability][casl-ability] into [Angular][angular] application. So, you can show or hide some components, buttons, etc based on user ability to see them.

## Installation

Expand Down Expand Up @@ -96,7 +96,7 @@ export class Session {
}
```

See [@casl/ability](/packages/casl-ability) package for more information on how to define abilities.
See [@casl/ability][casl-ability] package for more information on how to define abilities.

### 3. Check permissios in templates

Expand Down Expand Up @@ -165,3 +165,4 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! R
[contributing]: /CONTRIBUTING.md
[angular]: https://angular.io/
[update-ability]: https://stalniy.github.io/casl/abilities/2017/07/20/define-abilities.html#update-abilities
[casl-ability]: http://npmjs.com/package/@casl/ability
5 changes: 3 additions & 2 deletions packages/casl-aurelia/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CASL Aurelia [![@casl/aurelia NPM version](https://badge.fury.io/js/%40casl%2Faurelia.svg)](https://badge.fury.io/js/%40casl%2Faurelia) [![CASL Documentation](https://img.shields.io/badge/documentation-available-brightgreen.svg)](https://stalniy.github.io/casl/) [![CASL Join the chat at https://gitter.im/stalniy-casl/casl](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/stalniy-casl/casl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This package allows to integrate [@casl/ability](/packages/casl-ability) into [Aurelia][aurelia] application. So, you can show or hide some components, buttons, etc based on user ability to see them.
This package allows to integrate [@casl/ability][casl-ability] into [Aurelia][aurelia] application. So, you can show or hide some components, buttons, etc based on user ability to see them.

## Installation

Expand Down Expand Up @@ -98,7 +98,7 @@ export class Session {
}
```

See [@casl/ability](/packages/casl-ability) package for more information on how to define abilities.
See [@casl/ability][casl-ability] package for more information on how to define abilities.

### 3. Check permissios in templates

Expand All @@ -121,3 +121,4 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! R
[contributing]: /CONTRIBUTING.md
[aurelia]: https://aurelia.io/
[update-ability]: https://stalniy.github.io/casl/abilities/2017/07/20/define-abilities.html#update-abilities
[casl-ability]: http://npmjs.com/package/@casl/ability
8 changes: 5 additions & 3 deletions packages/casl-mongoose/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [CASL Mongoose](https://stalniy.github.io/casl/) [![@casl/mongoose NPM version](https://badge.fury.io/js/%40casl%2Fmongoose.svg)](https://badge.fury.io/js/%40casl%2Fmongoose) [![CASL Documentation](https://img.shields.io/badge/documentation-available-brightgreen.svg)](https://stalniy.github.io/casl/) [![CASL Join the chat at https://gitter.im/stalniy-casl/casl](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/stalniy-casl/casl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This package connects CASL and MongoDB. Basically it allows to fetch records based on CASL rules from MongoDB. That means you can easily answer on the question: "Which records can be read?" or "Which records can be updated?". Lets see how
This package connects [CASL][casl] and [MongoDB](https://www.mongodb.com/). In other words, it allows to fetch records based on CASL rules from MongoDB. That means you can easily answer on the question: "Which records can be read?" or "Which records can be updated?". Lets see how

## Installation

Expand Down Expand Up @@ -53,9 +53,9 @@ const ability = require('./ability') // defines Ability instance
Post.accessibleBy(ability).exec()
```

Check [@casl/ability](/packages/casl-ability) package to understand how to define abilities.
Check [@casl/ability][casl-ability] package to understand how to define abilities.

#### Permitted Fields plugins
#### Permitted Fields plugin

`permittedFieldsPlugin` is a [mongoose][mongoose] plugin which adds `permittedFieldsBy` method to instance and static methods.
That method allow to retrieve accessible fields by ability:
Expand Down Expand Up @@ -142,3 +142,5 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! R
[mongoose]: http://mongoosejs.com/
[mongo-adapter]: https://mongodb.github.io/node-mongodb-native/
[database-integration]: https://stalniy.github.io/casl/abilities/database/integration/2017/07/22/database-integration.html
[casl-ability]: https://github.com/stalniy/casl
[casl]: https://github.com/stalniy/casl
5 changes: 3 additions & 2 deletions packages/casl-react/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CASL React [![@casl/react NPM version](https://badge.fury.io/js/%40casl%2Freact.svg)](https://badge.fury.io/js/%40casl%2Freact) [![](https://img.shields.io/npm/dm/%40casl%2Freact.svg)](https://www.npmjs.com/package/%40casl%2Freact) [![CASL Documentation](https://img.shields.io/badge/documentation-available-brightgreen.svg)](https://stalniy.github.io/casl/) [![CASL Join the chat at https://gitter.im/stalniy-casl/casl](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/stalniy-casl/casl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This package allows to integrate [@casl/ability](/packages/casl-ability) into [React][react] application. So, you can show or hide UI elements based on user ability to see them.
This package allows to integrate [@casl/ability][casl-ability] into [React][react] application. So, you can show or hide UI elements based on user ability to see them.

## Installation

Expand Down Expand Up @@ -171,7 +171,7 @@ export class LoginComponent extends Component {
```

Obviously, in this case your server API should provide the list of user abilities in `rules` field of the response.
See [@casl/ability](/packages/casl-ability) package for more information on how to define abilities.
See [@casl/ability][casl-ability] package for more information on how to define abilities.

### 3. Property names and aliases

Expand Down Expand Up @@ -240,3 +240,4 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! R
[react]: https://reactjs.org/
[casl-react-example]: https://github.com/stalniy/casl-react-example
[react-ctx-api]: https://medium.com/dailyjs/reacts-%EF%B8%8F-new-context-api-70c9fe01596b
[casl-ability]: https://www.npmjs.com/package/@casl/ability
5 changes: 3 additions & 2 deletions packages/casl-vue/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CASL Vue [![@casl/vue NPM version](https://badge.fury.io/js/%40casl%2Fvue.svg)](https://badge.fury.io/js/%40casl%2Fvue) [![](https://img.shields.io/npm/dm/%40casl%2Fvue.svg)](https://www.npmjs.com/package/%40casl%2Fvue) [![CASL Documentation](https://img.shields.io/badge/documentation-available-brightgreen.svg)](https://stalniy.github.io/casl/) [![CASL Join the chat at https://gitter.im/stalniy-casl/casl](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/stalniy-casl/casl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This package allows to integrate [@casl/ability](/packages/casl-ability) into [Vue][vue] application. So, you can show or hide UI elements based on user ability to see them.
This package allows to integrate [@casl/ability][casl-ability] into [Vue][vue] application. So, you can show or hide UI elements based on user ability to see them.

## Installation

Expand Down Expand Up @@ -77,7 +77,7 @@ Alternatively, you can just update existing instance, for example, in `SignIn.vu
```

Obviously, in this case your server API should provide the list of user abilities in `rules` field of the response.
See [@casl/ability](/packages/casl-ability) package for more information on how to define abilities.
See [@casl/ability][casl-ability] package for more information on how to define abilities.

### 3. Check permissions in templates

Expand Down Expand Up @@ -214,3 +214,4 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! R
[vue]: https://vuejs.org/
[casl-vue-example]: https://github.com/stalniy/casl-vue-example
[casl-vuex-example]: https://github.com/stalniy/casl-vue-api-example
[casl-ability]: https://www.npmjs.com/package/@casl/ability

0 comments on commit a74086b

Please sign in to comment.