Skip to content
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

Jump to bottom

Fix badges and update some formatting #36

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix badges and update some formatting #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 3 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ name = "jwalk"
version = "0.6.2"
authors = ["Jesse Grosjean <jesse@hogbaysoftware.com>", "Sebastian Thiel <byronimo@gmail.com>"]
description = "Filesystem walk performed in parallel with streamed and sorted results."
documentation = "https://docs.rs/jwalk/"
homepage = "https://github.com/byron/jwalk"
repository = "https://github.com/byron/jwalk"
documentation = "https://docs.rs/jwalk"
homepage = "https://github.com/Byron/jwalk"
repository = "https://github.com/Byron/jwalk"
readme = "README.md"
keywords = ["directory", "recursive", "walk", "iterator", "parallel"]
categories = ["filesystem", "concurrency"]
Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@ jwalk

Filesystem walk.

- Performed in parallel using rayon
- Performed in parallel using Rayon
- Entries streamed in sorted order
- Custom sort/filter/skip/state

[![Build Status](https://travis-ci.org/Byron/jwalk.svg?branch=main)](https://travis-ci.org/Byron/jwalk)
[![Latest version](http://meritbadge.herokuapp.com/jwalk)](https://crates.io/crates/jwalk)
[![Build Status](https://github.com/Byron/jwalk/workflows/Rust/badge.svg)](https://github.com/Byron/jwalk/actions)
[![Latest Version](https://img.shields.io/crates/v/jwalk.svg)](https://crates.io/crates/jwalk)

### Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
jwalk = "0.5"
jwalk = "0.6"
```

Lean More: [docs.rs/jwalk](https://docs.rs/jwalk)
Expand Down Expand Up @@ -53,11 +53,11 @@ Directory traversal is already pretty fast. If you don't need this crate's speed
then `walkdir` provides a smaller and more tested single threaded
implementation.

This crates parallelism happens at the directory level. It will help when
This crate's parallelism happens at the directory level. It will help when
walking deep file systems with many directories. It wont help when reading a
single directory with many files.

### Benchmarks

[Benchmarks](https://github.com/jessegrosjean/jwalk/blob/main/benches/benchmarks.md)
[Benchmarks](https://github.com/Byron/jwalk/blob/main/benches/benchmarks.md)
comparing this crate with `walkdir` and `ignore`.
2 changes: 1 addition & 1 deletion benches/benchmarks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Time to walk linux's source tree on iMac (Retina 5K, 27-inch, Late 2015):
Time to walk Linux's source tree on iMac (Retina 5K, 27-inch, Late 2015):

| | threads | jwalk | ignore | walkdir |
|--------------------|----------|------------|------------|--------------|
Expand Down