Skip to content

Commit 2d896cf

Browse files
committed
Update readme
Signed-off-by: Jay Wang <[email protected]>
1 parent 51e4042 commit 2d896cf

File tree

2 files changed

+27
-14
lines changed

2 files changed

+27
-14
lines changed

CITATION.cff

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
abstract: Recommender for recommender letter writers
2+
authors:
3+
- family-names: Wang
4+
given-names: Zijie J.
5+
orcid: 0000-0003-4360-1423
6+
cff-version: 1.2.0
7+
date-released: '2024-07-09'
8+
doi: 10.5281/zenodo.12697229
9+
license:
10+
- mit
11+
repository-code: https://github.com/xiaohk/recrec/tree/v0.0.3
12+
title: 'RecRec: Recommender for Recommender Letter Writers'
13+
type: software
14+
version: v0.0.3

README.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@
66

77
[![Github Actions Status](https://github.com/xiaohk/recrec/workflows/build/badge.svg)](https://github.com/xiaohk/recrec/actions/workflows/build.yml)
88
[![license](https://img.shields.io/badge/License-MIT-blue)](https://github.com/xiaohk/recrec/blob/main/LICENSE)
9-
[![npm](https://img.shields.io/npm/v/recrec?color=yellow)](https://www.npmjs.com/package/recrec)
9+
[![npm](https://img.shields.io/npm/v/recrec?color=orange)](https://www.npmjs.com/package/recrec)
10+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.12697177.svg)](https://doi.org/10.5281/zenodo.12697177)
1011

1112
Recommender for recommendation letter writers 👍
1213

1314
<table>
1415
<tr>
15-
<td colspan="2"><a href="https://xiaohk.github.io/recrec"><img width="830px" src='https://github.com/xiaohk/gifs/blob/main/recrec-600.gif?raw=true'></a></td>
16+
<td colspan="2"><a href="https://xiaohk.github.io/recrec"><img width="800px" src='https://github.com/xiaohk/gifs/blob/main/recrec-600.gif?raw=true'></a></td>
1617
</tr>
1718
<tr></tr>
1819
<tr align="center">
@@ -97,27 +98,25 @@ Navigate to localhost:3000. You should see RecRec running in your browser :)
9798

9899
RecRec is created by <a href='https://zijie.wang/' target='_blank'>Jay Wang</a>.
99100

100-
<!----
101-
102101
## Citation
103102

104103
To learn more about RecRec and social prompt engineering, check out our [research paper](https://arxiv.org/abs/2401.14447).
105104

105+
If you find RecRec useful, please consider citing it.
106+
106107
```bibtex
107-
@article{wangWordflowSocialPrompt2024,
108-
title = {Wordflow: {{Social Prompt Engineering}} for {{Large Language Models}}},
109-
shorttitle = {Wordflow},
110-
author = {Wang, Zijie J. and Chakravarthy, Aishwarya and Munechika, David and Chau, Duen Horng},
108+
@misc{wangRecRecRecommenderRecommender2024,
109+
title = {{{RecRec}}: {{Recommender}} for {{Recommender Letter Writers}}},
110+
shorttitle = {{{RecRec}}},
111+
author = {Wang, Zijie J.},
111112
year = {2024},
112-
url = {http://arxiv.org/abs/2401.14447},
113-
urldate = {2024-01-29},
114-
archiveprefix = {arxiv},
115-
journal = {arXiv 2401.14447}
113+
doi = {10.5281/ZENODO.12697177},
114+
url = {https://zenodo.org/doi/10.5281/zenodo.12697177},
115+
urldate = {2024-07-09},
116+
copyright = {MIT License}
116117
}
117118
```
118119

119-
--->
120-
121120
## License
122121

123122
The software is available under the [MIT License](https://github.com/xiaohk/recrec/blob/main/LICENSE).

0 commit comments

Comments
 (0)