Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
samscott89 committed Nov 29, 2020
1 parent 9d44f92 commit 3ad996f
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
libpasta - Password Storage Algorithms
===================================

[![Build Status][build_badge]][build_status]
[![Code Coverage][coverage_badge]][coverage_report]
[![Development][badge-ci]][badge-ci-link]


#### _Making Password Painless_

Expand Down Expand Up @@ -54,17 +54,11 @@ which is a C-API wrapper built around the Rust code.

## Roadmap

libpasta is still currently in development. The current version is `0.0.1`
representing a pre-release. After gathering some initial feedback we will
move to `0.1.0` release, at which point libpasta will be ready to use in
test environments. We are targetting a stable `1.0.0` release once the API
is stable, and testing reveals no major issues.
libpasta is still currently in maintenance mode. The current API is at 0.1.1
and is reasonably stable. But at this time no future improvements are planned.

## Contributing

libpasta is still in its infancy, and the best way to contribute right now is
to start testing it in new projects.

Please feel free to open new issues or pull requests for any bugs found, feature
requests, or general suggestions.

Expand All @@ -76,8 +70,8 @@ when dealing with any disagreements or problems.
libpasta is licensed under the MIT license: [License](license).


[build_badge]: https://travis-ci.org/libpasta/libpasta.svg?branch=master
[build_status]: https://travis-ci.org/libpasta/libpasta
[badge-ci]: https://github.com/libpasta/libpasta/workflows/Rust%20CI%20checks/badge.svg
[badge-ci-link]: https://github.com/libpasta/libpasta/actions?query=workflow%3A%22Rust+CI+checks%22+branch%3Amain
[coverage_badge]: https://codecov.io/gh/libpasta/libpasta/graph/badge.svg
[coverage_report]: https://codecov.io/gh/libpasta/libpasta/
[documentation]: https://libpasta.github.io/doc/libpasta/
Expand Down

1 comment on commit 3ad996f

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rust Benchmark

Benchmark suite Current: 3ad996f Previous: da15f56 Ratio
pasta_hash 69471229 ns/iter (± 4144797) 66893034 ns/iter (± 834676) 1.04
pasta_hash_dyn_alg 68674805 ns/iter (± 3640681) 66193010 ns/iter (± 786911) 1.04
argon2/native_1 2860595 ns/iter (± 126688) 2535415 ns/iter (± 2113) 1.13
argon2/native_4 2385612 ns/iter (± 88992) 2241511 ns/iter (± 61874) 1.06
argon2/ffi_1 2638763 ns/iter (± 105984) 2336749 ns/iter (± 42626) 1.13
argon2/ffi_4 3120916 ns/iter (± 284687) 3387355 ns/iter (± 79983) 0.92
argon2/pasta_1 2702820 ns/iter (± 120760) 2537987 ns/iter (± 3007) 1.06
argon2/pasta_4 2372831 ns/iter (± 96698) 2246733 ns/iter (± 41565) 1.06

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.