Skip to content
This repository was archived by the owner on Sep 16, 2025. It is now read-only.

Commit 35295e5

Browse files
chore(README): add badges (#4)
chore(README): add note about modelName being case sensitive
1 parent ba97bc5 commit 35295e5

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
A plugin for [Strapi](https://github.com/strapi/strapi) that provides the ability to auto slugify a field for any content type. It also provides a findOne by slug endpoint as a utility.
44

5+
[![Downloads](https://img.shields.io/npm/dm/strapi-plugin-slugify?style=for-the-badge)](https://img.shields.io/npm/dm/strapi-plugin-slugify?style=for-the-badge)
6+
[![Install size](https://img.shields.io/npm/l/strapi-plugin-slugify?style=for-the-badge)](https://img.shields.io/npm/l/strapi-plugin-slugify?style=for-the-badge)
7+
[![Package version](https://img.shields.io/github/v/release/ComfortablyCoding/strapi-plugin-slugify?style=for-the-badge)](https://img.shields.io/github/v/release/ComfortablyCoding/strapi-plugin-slugify?style=for-the-badge)
8+
59
## Requirements
610

711
The installation requirements are the same as Strapi itself and can be found in the documentation on the [Quick Start](https://strapi.io/documentation/developer-docs/latest/getting-started/quick-start.html) page in the Prerequisites info card.
@@ -76,6 +80,8 @@ Any time the respective content types have an entity created or updated the slug
7680

7781
Hitting the `/api/slugify/slugs/:modelName/:slug` endpoint for any configured content types will return the entity type that matches the slug in the url.
7882

83+
**IMPORTANT** The modelName is case sensitive and must match exactly with the name defined in the configuration.
84+
7985
#### Additional Requirements
8086

8187
Like all other created API endpoints the `findSlug` route must be allowed under `User & Permissions -> Roles -> Public/Authenticated` for the user to be able to access the route.
@@ -106,7 +112,7 @@ If an article with the slug of `lorem-ipsum-dolor` exists the reponse will look
106112
}
107113
```
108114

109-
**IMPORTANT NOTE** To be inline with Strapi's default behaviour for single types if an article with the slug of `lorem-ipsum-dolor` does not exist a 404 error will be returned.
115+
**IMPORTANT NOTE** To be inline with Strapi's default behavior for single types if an article with the slug of `lorem-ipsum-dolor` does not exist a 404 error will be returned.
110116

111117
```json
112118
{

0 commit comments

Comments
 (0)