From bd8af3fe349242f9e43eacfc5412dbd03b1f79d7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=B9=A4=E4=BB=99?= <guoyunhe.gyh@alibaba-inc.com>
Date: Wed, 7 Feb 2024 11:45:48 +0800
Subject: [PATCH] docs: readme

---
 packages/f2elint/README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/packages/f2elint/README.md b/packages/f2elint/README.md
index 1033b26..4396846 100755
--- a/packages/f2elint/README.md
+++ b/packages/f2elint/README.md
@@ -2,8 +2,28 @@
 
 f2elint 是《阿里巴巴前端规约》的配套初始化工具，可以为各种前端和 Node.js 项目一键接入规约，保障项目的编码规范和代码质量。
 
+## CLI
+
 ```bash
 npx f2elint
 ```
 
 ![screenshot](https://github.com/alibaba/f2e-spec/assets/5836790/80b5c4fd-6ab1-4423-8ae5-0572777db0a7)
+
+## API
+
+```bash
+npm install --save f2elint
+```
+
+```js
+import { f2elint, TemplateType } from 'f2elint';
+
+await f2elint('path/to/project/root', {
+  template: TemplateType.ReactTS,
+  stylelint: true,
+  prettier: true,
+  lintStaged: true,
+  commitlint: false,
+})
+```