Skip to content

Commit 785e397

Browse files
Small README update
1 parent 95b4ab0 commit 785e397

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

README.Rmd

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,12 @@ We expect this feature to be needing further polishing in future releases, and w
9292
To accommodate for the cost of mutations, `caugi` graphs are built lazily. This means that when you mutate the graph, for example by adding edges to it, the graph edits are stored in R, but not in Rust. When you then need to query the graphs, the graph will rebuild itself in Rust, and the query will be executed on the newly built graph. You can also use the `build(cg)` function to force building the graph in Rust at any time.
9393

9494
## Why?
95-
It's fast, _dawg_ 🐶 See the [vignette on performance](vignette("performance")) for benchmarks.
95+
It's fast, _dawg_ 🐶 See the [vignette on performance](https://frederikfabriciusbjerre.github.io/caugi/articles/performance.html) for benchmarks.
9696

9797
## Contribution
9898
Would you like to contribute? Great! Please follow the tidyverse style guide for R code. Before opening a PR, run `styler::style_pkg()` for R and `cargo fmt` for Rust, and make sure to write tests for new features.
9999

100100

101-
Did you find an issue? That's paw-ful! Please report an [issue](https://github.com/frederikfabriciusbjerre/caugi/issues)
101+
Did you find run into problems? That's _paw-ful_!
102+
Please report an [issue](https://github.com/frederikfabriciusbjerre/caugi/issues).
102103

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,13 +122,14 @@ time.
122122
## Why?
123123

124124
It’s fast, *dawg* 🐶 See the [vignette on
125-
performance](vignette(%22performance%22)) for benchmarks.
125+
performance](https://frederikfabriciusbjerre.github.io/caugi/articles/performance.html)
126+
for benchmarks.
126127

127128
## Contribution
128129

129130
Would you like to contribute? Great! Please follow the tidyverse style
130131
guide for R code. Before opening a PR, run `styler::style_pkg()` for R
131132
and `cargo fmt` for Rust, and make sure to write tests for new features.
132133

133-
Did you find an issue? That’s paw-ful! Please report an
134-
[issue](https://github.com/frederikfabriciusbjerre/caugi/issues)
134+
Did you find run into problems? That’s *paw-ful*! Please report an
135+
[issue](https://github.com/frederikfabriciusbjerre/caugi/issues).

0 commit comments

Comments
 (0)