Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
Closes #93
  • Loading branch information
nathansam committed Aug 24, 2024
1 parent 31da9ce commit 6e2b04c
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 11 deletions.
18 changes: 16 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
# Changelog

## bibget 1.1.0

### Features

Multiple DOIs can now be provided by separating them with a space.

### Bug fixes

-h (--help) and -V (--version) flags should now work again.

### Documentation

Readme updated to describe the new multiple DOI feature.

## bibget 1.0.5

### Changed

The authors key is now parsed correctly (commas in a bibtex key shouldn't start
a new line)
The authors key is now formmated correctly (commas in a bibtex key shouldn't
start a new line now)

### Dependencies removed

Expand Down
51 changes: 42 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,44 @@
# bibget

[![CI](https://github.com/nathansam/bibget/actions/workflows/rust.yml/badge.svg)](https://github.com/nathansam/bibget/actions/workflows/rust.yml) [![crates.io](https://img.shields.io/crates/v/bibget.svg)](https://crates.io/crates/bibget) [![dependency status](https://deps.rs/repo/github/nathansam/bibget/status.svg)](https://deps.rs/repo/github/nathansam/bibget) [![MIT](https://img.shields.io/crates/l/bibget.svg)](https://github.com/nathansam/bibget/blob/master/LICENSE)
[![CI](https://github.com/nathansam/bibget/actions/workflows/rust.yml/badge.svg)](https://github.com/nathansam/bibget/actions/workflows/rust.yml) [![crates.io](https://img.shields.io/crates/v/bibget.svg)](https://crates.io/crates/bibget) [![dependency status](https://deps.rs/repo/github/nathansam/bibget/status.svg)](https://deps.rs/repo/github/nathansam/bibget) [![MIT](https://img.shields.io/crates/l/bibget.svg)](https://github.com/nathansam/bibget/blob/master/LICENSE)

Check warning on line 3 in README.md

View check run for this annotation

In Solidarity / Inclusive Language

Match Found

Please consider an alternative to `master`. Possibilities include: `primary`, `main`, `leader`, `active`, `writer`
Raw output
/master/gi

CLI tool to generate a BibTex entry from a DOI. Written in Rust and based on the [`doi2bib` crate](https://crates.io/crates/doi2bib).
Command line interface tool for generating BibTex entries from DOIs. Written in
Rust and based on the [`doi2bib` crate](https://crates.io/crates/doi2bib).

## Installation

`bibget` can be installed from source using `cargo`


Pre-compiled binaries for MacOS and Linux are available from the
[releases page](https://github.com/nathansam/bibget/releases) and do not require
Rust to be installed.

`bibget` can be installed from source using `cargo`. The most stable version is
hosted on [crates.io](https://crates.io/crates/bibget).

``` bash
# release version from crates.io
cargo install bibget
```

You can also install from GitHub if you want access to the latest pre-release
(likely with newer dependencies) or development (more experimental) builds.

# development version from GitHub
``` bash
# pre-release version
cargo install --git https://github.com/nathansam/bibget.git bibget
# development version
cargo install --git https://github.com/nathansam/bibget.git --branch dev bibget
```

## Usage

`bibget` supports an optional `-f/--file` argument for writing the BibTex entry to a file. The file will automatically be created if it does not already exist. If the file exists then the entry will be appended to the file.
`bibget` is a command line tool that takes a DOI as an argument and returns
output in BibTex format. Multiple DOIs can be passed via whitespace separation.

``` bash
> bibget -f test.bib 10.1002/sim.1186
bibget 10.1002/sim.1186 10.1007/978-3-319-19425-7
```

```
``` bibtex
@article{Higgins_2002,
title = {Quantifying heterogeneity in a meta‐analysis},
volume = {21},
Expand All @@ -42,4 +53,26 @@ cargo install --git https://github.com/nathansam/bibget.git bibget
month = may,
pages = {1539–1558}
}
@book{Harrell__2015,
_2015,
title = {Regression Modeling Strategies: With Applications to Linear Models, Logistic and Ordinal Regression, and Survival Analysis},
ISBN = {9783319194257},
ISSN = {2197-568X},
url = {http://dx.doi.org/10.1007/978-3-319-19425-7},
DOI = {10.1007/978-3-319-19425-7},
journal = {Springer Series in Statistics},
publisher = {Springer International Publishing},
author = {Harrell , Frank E.},
year = {2015}
}
```

`bibget` supports an optional `-f/--file` flag for writing the BibTex to
file. If the specified file does not already exist, it will be created first.
Entries will be appended to the end of existing files instead.

``` bash
> bibget -f test.bib 10.1002/sim.1186
```

0 comments on commit 6e2b04c

Please sign in to comment.