@amrishkhan05/frankly 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# Frankly
|
|
4
4
|
|
|
5
5
|
<details open>
|
|
6
|
-
<summary><strong
|
|
6
|
+
<summary><strong><img src="https://img.icons8.com/ios-filled/24/000000/rocket.png" alt="Rocket" style="vertical-align:middle;"/> Tagline</strong></summary>
|
|
7
7
|
|
|
8
8
|
> **Your AI writes code. Frankly reviews it, frankly.**
|
|
9
9
|
|
|
@@ -21,30 +21,30 @@
|
|
|
21
21
|
|
|
22
22
|
---
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## <img src="https://img.icons8.com/ios-filled/24/000000/target.png" alt="Target" style="vertical-align:middle;"/> What is Frankly?
|
|
25
25
|
|
|
26
26
|
Frankly is a **local‑first change‑intelligence engine** for coding agents. It inspects the current Git diff and your TypeScript/JavaScript project, then asks whether **every changed file and symbol earned its place**. No hidden LLM calls, no cloud dependencies – everything runs deterministically on your machine.
|
|
27
27
|
|
|
28
28
|
---
|
|
29
29
|
|
|
30
|
-
##
|
|
31
|
-
|
|
32
|
-
- [
|
|
33
|
-
- [
|
|
34
|
-
- [
|
|
35
|
-
- [
|
|
36
|
-
- [
|
|
37
|
-
- [
|
|
38
|
-
- [
|
|
39
|
-
- [
|
|
40
|
-
- [
|
|
41
|
-
- [
|
|
42
|
-
- [
|
|
43
|
-
- [
|
|
30
|
+
## <img src="https://img.icons8.com/ios-filled/24/000000/book.png" alt="Book" style="vertical-align:middle;"/> Table of Contents
|
|
31
|
+
|
|
32
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/rocket.png" alt="Rocket" style="vertical-align:middle;"/> Quick Start](#-quick-start)
|
|
33
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/search.png" alt="Search" style="vertical-align:middle;"/> The Ten‑Second Demo](#-the-ten-second-demo)
|
|
34
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/star.png" alt="Star" style="vertical-align:middle;"/> Features](#-features)
|
|
35
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/settings.png" alt="Gear" style="vertical-align:middle;"/> Installation & Usage](#-installation--usage)
|
|
36
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/puzzle.png" alt="Puzzle" style="vertical-align:middle;"/> Plugins & MCP Integration](#-plugins--mcp-integration)
|
|
37
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/tools.png" alt="Tools" style="vertical-align:middle;"/> CLI Reference](#-cli-reference)
|
|
38
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/wrench.png" alt="Wrench" style="vertical-align:middle;"/> Configuration](#-configuration)
|
|
39
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/combo-chart.png" alt="Chart" style="vertical-align:middle;"/> Benchmarks & Scoring](#-benchmarks--scoring)
|
|
40
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/lock.png" alt="Lock" style="vertical-align:middle;"/> Privacy & Security](#-privacy--security)
|
|
41
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/construction.png" alt="Construction" style="vertical-align:middle;"/> Roadmap](#-roadmap)
|
|
42
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/handshake.png" alt="Handshake" style="vertical-align:middle;"/> Contributing](#-contributing)
|
|
43
|
+
- [<img src="https://img.icons8.com/ios-filled/20/000000/user.png" alt="User" style="vertical-align:middle;"/> Author](#-author)
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
47
|
-
##
|
|
47
|
+
## <img src="https://img.icons8.com/ios-filled/24/000000/rocket.png" alt="Rocket" style="vertical-align:middle;"/> Quick Start
|
|
48
48
|
|
|
49
49
|
```bash
|
|
50
50
|
# Clone the repo
|
|
@@ -65,7 +65,7 @@ npm run build
|
|
|
65
65
|
|
|
66
66
|
---
|
|
67
67
|
|
|
68
|
-
##
|
|
68
|
+
## <img src="https://img.icons8.com/ios-filled/24/000000/search.png" alt="Search" style="vertical-align:middle;"/> The Ten‑Second Demo
|
|
69
69
|
|
|
70
70
|
```text
|
|
71
71
|
Task: Retry HTTP 429 responses
|