Updated README.org

Signed-off-by: TuDatTr <tuan-dat.tran@tudattr.dev>
master
TuDatTr 2023-06-10 22:10:41 +02:00
parent 1e4cee6b03
commit 23ed1274e3
1 changed files with 13 additions and 7 deletions

View File

@ -30,6 +30,15 @@ To search for citations using gsearch, you need to provide a search term as a co
#+begin_src shell
./gsearch --search_term "machine learning"
@book{zhou2021machine,
title={Machine learning},
author={Zhou, Zhi-Hua},
year={2021},
publisher={Springer Nature}
}
#+end_src
#+end_src
The above command will search for references related to "machine learning" and display the first reference in BibTeX format.
@ -39,16 +48,13 @@ gsearch supports the following command-line arguments:
- ~--search_term~ or ~-s~: The search term to be used for retrieving references. It is a required argument.
* Output
gsearch retrieves references using the gscite library and displays the first reference in BibTeX format. The output will be printed to the console.
* Dependencies
gsearch depends on the following libraries:
[[https://crates.io/crates/gscite][gscite]]: A Rust library for retrieving citations from Google Scholar.
[[https://crates.io/crates/futures_util][futures_util]]: A collection of utility functions and combinators for working with asynchronous Rust.
[[https://crates.io/crates/clap][clap]]: A powerful command-line argument parsing library for Rust.
- [[https://crates.io/crates/gscite][gscite]]: A Rust library for retrieving citations from Google Scholar.
- [[https://crates.io/crates/futures_util][futures_util]]: A collection of utility functions and combinators for working with asynchronous Rust.
- [[https://crates.io/crates/clap][clap]]: A powerful command-line argument parsing library for Rust.
* Contributing