Skip to content

docs: enhance README with additional details #209

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

Open
chenjiahan wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: enhance README with additional details #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dae0ec5
docs: enhance README with additional details
chenjiahan Jan 2, 2026
3e2d699
docs: fix
chenjiahan Jan 2, 2026
470a6e3
Merge branch 'main' into improve_readme_0102
chenjiahan Jan 2, 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
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ resolver = "2"
license = "MIT"
description = "Rusty webpack-sources port."
keywords = ["sources", "sourcemap"]
repository = "https://github.com/web-infra-dev/rspack-sources"
repository = "https://github.com/rstackjs/rspack-sources"
documentation = "https://docs.rs/rspack-sources"
readme = "README.md"

Expand Down
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# rspack-sources

[![CI](https://github.com/web-infra-dev/rspack-sources/actions/workflows/CI.yaml/badge.svg)](https://github.com/web-infra-dev/rspack-sources/actions/workflows/CI.yaml)
[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/web-infra-dev/rspack-sources)
[![CI](https://github.com/rstackjs/rspack-sources/actions/workflows/CI.yaml/badge.svg)](https://github.com/rstackjs/rspack-sources/actions/workflows/CI.yaml)
[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/rstackjs/rspack-sources)

Rust port of [`webpack-sources`](https://github.com/webpack/webpack-sources).
Rust port of [`webpack-sources`](https://github.com/webpack/webpack-sources), providing composable sources and source map utilities for Rspack.

## Documentation

API reference: <https://docs.rs/rspack-sources>

## Credits

Thanks to the contributors of [`webpack-sources`](https://github.com/webpack/webpack-sources) for the original design.

## License

[MIT licensed](https://github.com/rstackjs/rspack-sources/blob/main/LICENSE).