Skip to content

Prepare documentation for v1.0 #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
zaldih wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Prepare documentation for v1.0 #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
49082df
perf(core): optimize folder size calculation with chunking and reduce…
zaldih Jan 10, 2026
dcf974a
docs: update readme with v1.0
zaldih Jan 20, 2026
a35b769
docs: improve readme, profiles and api
zaldih Jan 21, 2026
9f2400b
docs(readme): add note in usage
zaldih Jan 21, 2026
fa61fa5
docs(readme): add one more example
zaldih Jan 25, 2026
22411db
Merge branch 'main' into docs/1-0-0
zaldih Jan 25, 2026
5c6d98d
docs(readme): add default excluded directories link
zaldih Jan 25, 2026
6a40b06
docs: update docs with main changes
zaldih May 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# NPKill API

This document does not include all project documentation at this stage. It brings together the basic concepts.
This document describes the public core API of npkill and its fundamental concepts.
For more details see the project interfaces.

> [!WARNING]
>
> Some things may change in future patches until the API is 100% stable. Please leave me your feedback if you use it!

- [NPKill API](#npkill-api)
- [Interface: `Npkill`](#interface-npkill)
- [`startScan$(rootPath, options?)`](#startscanrootpath-options)
Expand Down
Loading
Loading