Skip to content

Commit 38804bb

Browse files
committed
docs(readme): fix dead links and enhance clarity
1 parent 4b65cef commit 38804bb

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

README.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@
1212

1313
<p align="center"><code>npm install stacklyn</code></p>
1414

15-
<p align="center">Pretty cool, right? Well there's actually even more!</p>
15+
<p align="center">
16+
<img src="https://img.shields.io/npm/v/stacklyn" alt="npm">
17+
<img src="https://img.shields.io/bundlephobia/minzip/stacklyn?label=Gzipped&color=4c5eb4" alt="Gzipped: 7KiB">
18+
<img src="https://img.shields.io/badge/License-Apache--2.0-4B0082?style=flat" alt="License: Apache-2.0">
19+
</p>
1620

1721
---
1822

@@ -23,7 +27,7 @@ Live demo is at https://stacklynjs.github.io/demo.
2327
First and foremost, `npm install stacklyn`.
2428
*(and/or use one of the direct import methods listed below)*
2529

26-
Here's some example usage code so you don't feel lost while I finish writing the docs and demos:
30+
Here's some example usage code so you don't feel lost while I finish writing the docs:
2731

2832
```js
2933
import Stacklyn from "stacklyn";
@@ -34,28 +38,25 @@ try {
3438
// array of objects
3539
const parsed = Stacklyn.parse(error);
3640

37-
// still an array of objects
41+
// still an array of objects, but with source map info
3842
const mapped = Stacklyn.map(parsed);
3943

4044
mapped.forEach(frame => console.log(frame.raw)); // log the sourcemapped stack frames
41-
42-
// i would've done a better guide but i've been working on this since may 26
43-
// and since i wanted to release it for so long this will do for now.
44-
// - doctoon, sorry for inconvinence, docs are coming soon i promise
4545
}
4646
```
4747

4848
### What we offer:
49-
- Stacktrace Parsing (for more info, see [`parse()`](https://stacklynjs.github.io/docs?p=api/parse))
50-
- Turn a parsed stack back into a string (for more info, see [`stringify()`](https://stacklynjs.github.io/docs?p=api/stringify))
51-
- Stacktrace Converting (for more info, see [`convert()`](https://stacklynjs.github.io/docs?p=api/convert))
52-
- Support for V8 `CallSite` objects (for more info, see [`parseCS()`](https://stacklynjs.github.io/docs?p=api/parseCS) and [`getCallSites()`](https://stacklynjs.github.io/docs?p=api/getCallSites))
53-
- Source Maps (for more info, see [`map()`](https://stacklynjs.github.io/docs?p=api/map))
54-
- Enriching frames with context info (for more info, see [`enrich()`](https://stacklynjs.github.io/docs?p=api/enrich))
55-
- Make error properties enumerable (for more info, see [`serializeError()`](https://stacklynjs.github.io/docs?p=api/serializeError))
56-
- And best of all, supports most stack trace formats you'll come across!
49+
- **Stacktrace Parsing:** Convert raw and hard to read stack strings into clean, structured data.
50+
- **Stacktrace Stringification:** Turn a parsed stack back into a string.
51+
- **Stacktrace Conversion:** Transform stack traces between different formats.
52+
- **Structured CallSite Info:** Directly work with static data gathered from V8 `CallSite` objects.
53+
- **Source Map Integration:** Map minified or transpiled stack frames back to their original source files and lines for accurate debugging.
54+
- **Context Enrichment:** Add valuable surrounding code context to each stack frame for deeper insights.
55+
- **Error Serialization:** Make error properties enumerable for easier serialization and logging.
56+
57+
And best of all, supports most stack trace formats you'll come across!
5758

58-
<sub>*Stacklyn V2 will add even more cool stuff! See the [roadmap](https://stacklynjs.github.io/docs?p=stacklyn/roadmap) to know more.*</sub>
59+
<sub>*Stacklyn V2 will add even more cool stuff! See the [roadmap](#roadmap) to know more.*</sub>
5960

6061
### Supported Formats
6162
- <img height="24" src="./images/chrome.png" align="center">&nbsp; Chrome 3+ (V8)
@@ -115,6 +116,17 @@ Note that with the way stacklyn is made, it works no matter what JS env you're r
115116
This means even in CSP'd environments (e.g. file://), you can still parse stack traces :D
116117
<sub>*(you cannot fetch local file information, best to use localhost for that)*</sub>
117118

119+
---
120+
## Roadmap
121+
- Docs: In progress
122+
123+
### V2 Roadmap
124+
- Extension System (`Stacklyn.createExtension`)
125+
- More Stack Formats (Graal.js, Hermes, JS-Interpreter, Duktape, XS, Jsish, NJS, Boa, QuickJS, LibJS)
126+
- Parse Bluebird extended stack traces
127+
- `overwrite` method to change the default runtime stack format, accepts a callback function
128+
---
129+
118130
## <img src="./images/stacklyn/Gold.png" height="32" align="center"> Contributing
119131
We welcome contributors!
120132
If you've found a bug, had a suggestion, etc. Feel free to submit an issue or PR!

0 commit comments

Comments
 (0)