From 65f927e4fc0641e5b06fada8954ade36e90be63f Mon Sep 17 00:00:00 2001
From: Don de Dieu Bolenge <dondedieubolenge@gmail.com>
Date: Thu, 22 Sep 2022 17:32:54 +0100
Subject: [PATCH] ref: update readme docs

---
 README.md | 36 +++++++++---------------------------
 1 file changed, 9 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index c2bda19..29698b0 100644
--- a/README.md
+++ b/README.md
@@ -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
-
 ```
\ No newline at end of file