update README

Author: wusatosi

README.md

@@ -5,3 +5,33 @@ SPDX-License-Identifier: <SPDX License Expression>
 # beman.inplace\_vector
 
 A dynamically-resizable vector with fixed capacity and embedded storage
+
+## Linting
+
+This project use [pre-commit](https://pre-commit.com/) framework for linting.
+
+### Install pre-commit
+
+```bash
+pip3 install pre-commit
+```
+
+[pre-commit] can be configured to automatically triggered before git commit,
+to install this functionality, run:
+
+```bash
+pre-commit install
+```
+
+### Running pre-commit
+
+```bash
+pre-commit run --all-files
+```
+
+This will download and check linting rules on all files.
+Apart from Markdown files, 
+`pre-commit` will automatically format the files 
+to conform with linting rules in place.
+
+### Run