Skip to content

Commit

Permalink
ref: update readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bolenge committed Sep 22, 2022
1 parent ca0a98c commit 65f927e
Showing 1 changed file with 9 additions and 27 deletions.
36 changes: 9 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,31 @@
# mbstring

Librairie javascript offrant des méthodes permettant de gérer des chaines e caractères (string)
JavaScript library offering methods for managing character chains (string)

## Installation

```bash
$ npm install --save mbstring
npm install --save mbstring
```

## API

```js
var mbstring = require("mbstring");
Or

```bash
yarn add mbstring
```

### mbstring.isUrlValid(url)

Permet de vérifier si un url est valide partant d'une regex de vérification

**Note** Cette méthode (fonction) a été enlevée dans la version 0.1.0, vu que d'autres personnes l'utilisaient déjà nous l'avons remis dans la version 0.1.1 partant d'une autre dépendance `mbregex`.

#### url

L'adresse url à vérifier
## API

```js
var url = "https://www.npm.com"
var url2 = "www n pm.com"

console.log(mbstring.isUrlValid(url)) // True
console.log(mbstring.isUrlValid(url2)) // False
var mbstring = require("mbstring");

```

### mbstring.ucFirst(text)
### mbstring.ucFirst(str: string)

Permet de mettre la première lettre d'un texte en majuscule

#### text

Le texte à modifier
Allow to capitalize the first character of string

```js
var text = "bolenge";
console.log(mbstring.ucFirst(text)); // Bolenge

```

0 comments on commit 65f927e

Please sign in to comment.