Merge pull request #8 from baileyluTCD/1.4.1-docs-pass

1.4.1 docs pass

Author: baileylu121

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing to `bun2nix`
+
+Thinking about contributing? - All pull requests and issues are welcome and I will work with you to attempt to resolve them in a resonable amount of time.
+
+To help with that, here are some developer notes:
+
+## Tests
+
+All tests for this project are ran through `nix flake check` and are a good way of checking if the whole project works. To ensure this remains the case automatically, [garnix](https://garnix.io/) has been setup for the repository to run automatically on pull requests.
+
+## Documentation
+
+More documentation is always welcome, if you have any ideas for anything more which could be documented do make a contribution. For now, the documentation is an [mdbook](https://rust-lang.github.io/mdBook/) in `docs/`.
+
+## Formatting
+
+[Treefmt](https://github.com/numtide/treefmt-nix) has been setup for this repo to keep code styling clean and git diffs as small as possible, it is checked for automatically, but please remember to run `nix fmt` before making a pull request.

Cargo.lock

@@ -9,7 +9,7 @@ rinja = "0.3.5"
 
 [package]
 name = "bun2nix"
-version = "1.4.0"
+version = "1.4.1"
 edition = "2021"
 
 [profile.release]

Cargo.toml

@@ -1,4 +1,11 @@
-![Bun2Nix Logo](./docs/src/favicon.svg)
+<div align="center">
+    <img alt="Bun2nix Logo" src="./docs/src/favicon.svg" alt="Bun2nix Logo" width="150" height="150">
+</div>
+
+<div align="center">
+    <a href="https://garnix.io/repo/baileyluTCD/bun2nix"><img alt="Built with Garnix" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2FbaileyluTCD%2Fbun2nix%3Fbranch%3Dmaster"></a>
+    <a href="https://baileylutcd.github.io/bun2nix/"><img alt="GitHub Pages Deployment" src="https://github.com/baileyluTCD/bun2nix/actions/workflows/gh-pages.yml/badge.svg"></a>
+</div>
 
 # Bun2Nix
 

README.md

@@ -1,7 +1,7 @@
 # Bun2Nix
 
 <div style="display: flex; flex-direction: column; align-items: center; width: 100%;">
-    <img src="./favicon.svg" alt="Bun2nix Logo" width="150" height="150">
+    <img alt="Bun2nix Logo" src="./favicon.svg" alt="Bun2nix Logo" width="150" height="150">
 </div>
 
 Bun2nix is a fast rust based tool for converting lockfiles generated with the [JavaScript](https://en.wikipedia.org/wiki/JavaScript) [Bun](https://bun.sh/) (v1.2+) package manager files to [Nix](https://nixos.wiki/) expressions, which allows them to be consumed to build Bun packages reproducibly.

docs/src/bun2nix.md

@@ -74,7 +74,7 @@ And place this in a file called `default.nix`
 ```nix
 { mkBunDerivation, ... }:
 mkBunDerivation {
-  name = "bun2nix-example";
+  pname = "bun2nix-example";
   version = "1.0.0";
 
   src = ./.;

docs/src/flake-installation.md

@@ -12,47 +12,18 @@ The recommended way to use `bun2nix` is by adding it to your `package.json` to a
 
 However, if you run without the `-o` flag it will produce a text output over stdout similar to other `lang2nix` tools, hence if you enforce formatting rules in your repository it is likely a good idea to pass it through a formatter before writing the file.
 
-## Cache
-
-`bun2nix` currently uses an sqlite cache for storing prefetched hashes which has to be cleared manually with `bun2nix cache clear`.
-
-> This is likely to change soon, see [here](https://github.com/baileyluTCD/bun2nix/issues/2) for details.
-
 ## Options
 
 Currently, the options available from the command line tool are as follows:
 
 ```
 Convert Bun (v1.2+) packages to Nix expressions
 
-Usage: bun2nix [OPTIONS] [COMMAND]
-
-Commands:
-  cache  Cache related subcommands
-  help   Print this message or the help of the given subcommand(s)
+Usage: bun2nix [OPTIONS]
 
 Options:
-  -l, --lock-file <LOCK_FILE>
-          The Bun (v1.2+) lockfile to use to produce the Nix expression
-
-          [default: ./bun.lock]
-
-  -o, --output-file <OUTPUT_FILE>
-          The output file to write to - if no file location is provided, print to stdout instead
-
-  -c, --cache-location <CACHE_LOCATION>
-          The sqlite database to use as the cache - will be created if it does not exist.
-
-          Default value of <system cache directory>/bun2nix is assigned when no value is passed to `cache_location`.
-
-          [default: ~/.cache/bun2nix]
-
-      --disable-cache
-          Disable usage of the cache entirely
-
-  -h, --help
-          Print help (see a summary with '-h')
-
-  -V, --version
-          Print version
+  -l, --lock-file <LOCK_FILE>      The Bun (v1.2+) lockfile to use to produce the Nix expression [default: ./bun.lock]
+  -o, --output-file <OUTPUT_FILE>  The output file to write to - if no file location is provided, print to stdout instead
+  -h, --help                       Print help
+  -V, --version                    Print version
 ```

docs/src/using-the-command-line-tool.md

@@ -1,3 +1,3 @@
-This directory contains [askama](https://docs.rs/askama/latest/askama/) templates for constructing the output nix files for `bun2nix`.
+This directory contains [rinja](https://docs.rs/rinja/latest/rinja/) templates for constructing the output nix files for `bun2nix`.
 
-If you are looking for something like a template to create your project based on, please see the `examples/` folder instead.
+If you are looking for something like a template to create your project based on, please see the `nix/templates/` folder instead.