Skip to content

Commit 21eab40

Browse files
authored
Update README.md
update readme with publication details
1 parent 6721bc7 commit 21eab40

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ A Streamlit Component for creating Speck molecular structures within Streamlit W
77
[![Website shields.io](https://img.shields.io/website-up-down-green-red/http/shields.io.svg)](https://hellostspeckmol.streamlitapp.com)
88
![GitHub last commit](https://img.shields.io/github/last-commit/avrabyt/st-speckmol?style=plastic)
99
![GitHub Release Date](https://img.shields.io/github/release-date/avrabyt/st-speckmol)
10+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11205344.svg)](https://doi.org/10.5281/zenodo.11205344)
1011

1112

1213

@@ -63,7 +64,20 @@ res = speck_plot(example_xyz)
6364

6465

6566
## Scientfic usage
66-
To cite any scientific usage, please refer to the GitHub repository [here](https://github.com/avrabyt/st-speckmol). Should you require additional assistance, feel free to reach out to me directly.
67+
To cite any scientific usage, please refer to the following citation:
68+
69+
```
70+
@software{Biswas_2024,
71+
author = {Avratanu Biswas},
72+
title = {st-speckmol},
73+
version = {v0.0.6.1},
74+
doi = {10.5281/zenodo.11205344},
75+
url = {https://github.com/avrabyt/st-speckmol},
76+
date = {2024-05-16}
77+
}
78+
79+
```
80+
For additional assistance, feel free to reach out to me directly.
6781

6882
## Related library - [Stmol](https://github.com/napoles-uach/stmol)
6983
During the development of the related library [Stmol](https://github.com/napoles-uach/stmol), we introduced the convenient `speck_plot()` function, allowing seamless integration of both libraries.
@@ -79,9 +93,6 @@ from stmol import speck_plot
7993

8094
```
8195

82-
## ⭐️ Support me to keep this development going ☕️
83-
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/AvraCodes)
84-
8596
## References
8697

8798
[Speck Online](http://wwwtyro.github.io/speck/)

0 commit comments

Comments
 (0)