Skip to content

Commit

Permalink
docs(readme): improvements to README
Browse files Browse the repository at this point in the history
  • Loading branch information
@zkat
zkat committed Apr 19, 2023
1 parent 24b6012 commit 7b63b07
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 32 deletions.
75 changes: 59 additions & 16 deletions README.md
View file
Expand Up @@ -4,43 +4,86 @@

</div>

[the benchmarks]: ./BENCHMARKS.md
[CONTRIBUTING.md]: ./CONTRIBUTING.md
[Warm cache comparison]: ./assets/benchmarks-warm-cache.png
[the benchmarks page]: ./BENCHMARKS.md
[our contribution guide]: ./CONTRIBUTING.md
[Apache 2.0 License]: ./LICENSE

> Yet another `node_modules/` package manager, I guess.
> Makes `node_modules/` happen. Fast. No fuss.
[![release](https://img.shields.io/github/v/release/orogene/orogene?display_name=tag&include_prereleases)](https://github.com/orogene/orogene/releases/latest)
[![npm](https://img.shields.io/npm/v/oro)](https://www.npmjs.com/package/oro)
[![crates.io](https://img.shields.io/crates/v/orogene.svg)](https://crates.io/crates/orogene)
[![GitHub checks
state](https://img.shields.io/github/checks-status/orogene/orogene/main)](https://github.com/orogene/orogene/actions/workflows/ci.yml?query=branch%3Amain)
[![CI](https://img.shields.io/github/checks-status/orogene/orogene/main)](https://github.com/orogene/orogene/actions/workflows/ci.yml?query=branch%3Amain)
[![Project
Roadmap](https://img.shields.io/badge/Roadmap-Project%20Roadmap-informational)](https://github.com/orgs/orogene/projects/2/views/1)
Roadmap](https://img.shields.io/badge/Roadmap-Orogene%20v1.0-informational)](https://github.com/orgs/orogene/projects/2/views/1)

Orogene is a next-generation package manager for tools that use
`node_modules/`, such as bundlers, CLI tools, and Node.js-based
applications. It's fast, robust, and meant to be easily integrated into
your workflows such that you never have to worry about whether your
`node_modules/` is up to date.

> *Note*: Orogene is still under heavy development and shouldn't be
> considered much more than a tech demo or proof of concept. Do not use in
> production yet.
> *Note*: Orogene is still under heavy development and may not yet be
> suitable for production use. It is missing some features that you might
> expect. Check [the roadmap](https://github.com/orgs/orogene/projects/2)
> to see where we're headed and [talk to
> us](https://github.com/orogene/orogene/discussions/categories/pain-points)
> about what you want/need!.
#### Performance
### Getting Started

Orogene is pretty fast and uses fewer resources than other package
managers! For details and benchmarks, see [the benchmarks]
You can install Orogene in various ways:

npx:
```sh
$ npx oro ping
```

NPM:
```sh
$ npm install -g oro
```

Cargo:
```sh
$ cargo install orogene
```

You can also find install scripts and archive downloads in [the latest
release](https://github.com/orogene/orogene/releases/latest).

### Usage

For usage documentation, see [the Orogene
docs](https://orogene.dev/book/), or run `$ oro help`.

If you just want to do something similar to `$ npm install`, you can run
`$ oro apply` in your project and go from there.

### Performance

Orogene is very fast and uses significantly fewer resources than other
package managers, in both memory and disk space. It's able to install some
non-trivial projects in sub-second time:

![Warm cache comparison]

For details and more benchmarks, see [the benchmarks page].

### Contributing

For information and help on how to contribute to Orogene, please see
[CONTRIBUTING.md].
For information and help on how to contribute to Orogene, please see [our
contribution guide].

### License

Orogene and all its sub-crates are licensed under the terms of the [Apache
2.0 License].

[the benchmarks]: https://orogene.dev/BENCHMARKS.html
[CONTRIBUTING.md]: https://github.com/orogene/orogene/blob/main/CONTRIBUTING.md
[Warm cache comparison]:
https://orogene.dev/assets/benchmarks-warm-cache.png
[the benchmarks page]: https://orogene.dev/BENCHMARKS.html
[our contribution guide]:
https://github.com/orogene/orogene/blob/main/CONTRIBUTING.md
[Apache 2.0 License]: https://github.com/orogene/orogene/blob/main/LICENSE
5 changes: 3 additions & 2 deletions README.tpl
View file
Expand Up @@ -4,8 +4,9 @@

</div>

[the benchmarks]: ./BENCHMARKS.md
[CONTRIBUTING.md]: ./CONTRIBUTING.md
[Warm cache comparison]: ./assets/benchmarks-warm-cache.png
[the benchmarks page]: ./BENCHMARKS.md
[our contribution guide]: ./CONTRIBUTING.md
[Apache 2.0 License]: ./LICENSE

{{readme}}
70 changes: 56 additions & 14 deletions src/lib.rs
View file
@@ -1,38 +1,80 @@
//! > Yet another `node_modules/` package manager, I guess.
//! > Makes `node_modules/` happen. Fast. No fuss.
//!
//! [![release](https://img.shields.io/github/v/release/orogene/orogene?display_name=tag&include_prereleases)](https://github.com/orogene/orogene/releases/latest)
//! [![npm](https://img.shields.io/npm/v/oro)](https://www.npmjs.com/package/oro)
//! [![crates.io](https://img.shields.io/crates/v/orogene.svg)](https://crates.io/crates/orogene)
//! [![GitHub checks
//! state](https://img.shields.io/github/checks-status/orogene/orogene/main)](https://github.com/orogene/orogene/actions/workflows/ci.yml?query=branch%3Amain)
//! [![CI](https://img.shields.io/github/checks-status/orogene/orogene/main)](https://github.com/orogene/orogene/actions/workflows/ci.yml?query=branch%3Amain)
//! [![Project
//! Roadmap](https://img.shields.io/badge/Roadmap-Project%20Roadmap-informational)](https://github.com/orgs/orogene/projects/2/views/1)
//! Roadmap](https://img.shields.io/badge/Roadmap-Orogene%20v1.0-informational)](https://github.com/orgs/orogene/projects/2/views/1)
//!
//! Orogene is a next-generation package manager for tools that use
//! `node_modules/`, such as bundlers, CLI tools, and Node.js-based
//! applications. It's fast, robust, and meant to be easily integrated into
//! your workflows such that you never have to worry about whether your
//! `node_modules/` is up to date.
//!
//! > *Note*: Orogene is still under heavy development and shouldn't be
//! > considered much more than a tech demo or proof of concept. Do not use in
//! > production yet.
//! > *Note*: Orogene is still under heavy development and may not yet be
//! > suitable for production use. It is missing some features that you might
//! > expect. Check [the roadmap](https://github.com/orgs/orogene/projects/2)
//! > to see where we're headed and [talk to
//! > us](https://github.com/orogene/orogene/discussions/categories/pain-points)
//! > about what you want/need!.
//!
//! ### Performance
//! ## Getting Started
//!
//! Orogene is pretty fast and uses fewer resources than other package
//! managers! For details and benchmarks, see [the benchmarks]
//! You can install Orogene in various ways:
//!
//! npx:
//! ```sh
//! $ npx oro ping
//! ```
//!
//! NPM:
//! ```sh
//! $ npm install -g oro
//! ```
//!
//! Cargo:
//! ```sh
//! $ cargo install orogene
//! ```
//!
//! You can also find install scripts and archive downloads in [the latest
//! release](https://github.com/orogene/orogene/releases/latest).
//!
//! ## Usage
//!
//! For usage documentation, see [the Orogene
//! docs](https://orogene.dev/book/), or run `$ oro help`.
//!
//! If you just want to do something similar to `$ npm install`, you can run
//! `$ oro apply` in your project and go from there.
//!
//! ## Performance
//!
//! Orogene is very fast and uses significantly fewer resources than other
//! package managers, in both memory and disk space. It's able to install some
//! non-trivial projects in sub-second time:
//!
//! ![Warm cache comparison]
//!
//! For details and more benchmarks, see [the benchmarks page].
//!
//! ## Contributing
//!
//! For information and help on how to contribute to Orogene, please see
//! [CONTRIBUTING.md].
//! For information and help on how to contribute to Orogene, please see [our
//! contribution guide].
//!
//! ## License
//!
//! Orogene and all its sub-crates are licensed under the terms of the [Apache
//! 2.0 License].
//!
//! [the benchmarks]: https://orogene.dev/BENCHMARKS.html
//! [CONTRIBUTING.md]: https://github.com/orogene/orogene/blob/main/CONTRIBUTING.md
//! [Warm cache comparison]:
//! https://orogene.dev/assets/benchmarks-warm-cache.png
//! [the benchmarks page]: https://orogene.dev/BENCHMARKS.html
//! [our contribution guide]:
//! https://github.com/orogene/orogene/blob/main/CONTRIBUTING.md
//! [Apache 2.0 License]: https://github.com/orogene/orogene/blob/main/LICENSE

use std::{
Expand Down

0 comments on commit 7b63b07

Please sign in to comment.