update readme

.pre-commit-config.yaml

@@ -2,26 +2,23 @@ default_stages:
   - commit
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.4.0
     hooks:
       - id: end-of-file-fixer
 
   - repo: local
     hooks:
-    # NOTE: This is a total unnecessary check, just used as part of the
-    #       template. Remove this after creating the template.
-
-    - id: black
+    - entry: black
+      id: black
       name: black
-      entry: black
       language: system
       pass_filenames: true
       types:
         - python
 
     - id: isort
-      name: isort
       entry: isort
+      name: isort
       language: system
       pass_filenames: true
       types:

README.md

@@ -6,6 +6,17 @@ This Project aims to facilitate the teaching of mass transfer phenomena. Designe
 
 Now this repo has a module to graph an example for mcthiele solution to binary destilation
 
+## Example
+
+```python
+from fqlearn import McCabeThiele
+
+model = McCabeThiele()
+model.set_data(compound_a="methanol", compound_b="water")
+model.fit(xF=0.5, xD=0.94, xW=0.05)
+model.plot()
+```
+
 ![mccabe thiele](docs/dest.png)
 
 ## Credits