Skip to content

Commit 4afbed2

Browse files
authored
Update README.md
1 parent 95004e6 commit 4afbed2

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,21 @@
88
[![cffconvert](https://github.com/citation-file-format/cff-initializer-javascript/actions/workflows/cffconvert.yml/badge.svg)](https://github.com/citation-file-format/cff-initializer-javascript/actions/workflows/cffconvert.yml)
99
[![zenodraft](https://github.com/citation-file-format/cff-initializer-javascript/actions/workflows/zenodraft.yml/badge.svg)](https://github.com/citation-file-format/cff-initializer-javascript/actions/workflows/zenodraft.yml)
1010

11-
# cffinit: a web form to initialize CITATION.cff files
11+
# cffinit: a web application to create CITATION.cff files
1212

13-
- Check out the **live version** [here](https://citation-file-format.github.io/cff-initializer-javascript/).
14-
- For the rationale behind CITATION.cff files, read [the blog](https://www.software.ac.uk/blog/2017-12-12-standard-format-citation-files).
13+
## What cffinit can do for you?
14+
When you made some software and you want to include instructions on how to cite it, CITATION.cff files are the answer. However, sometimes it's tricky to ensure you write valid CFF. This tool helps mitigate that problem by generating the CFF text using a web form with form validation and user feedback.
15+
16+
## Information for users
17+
- Check out the **live version** at <https://citation-file-format.github.io/cff-initializer-javascript/>.
18+
- For the rationale behind CITATION.cff files, you can read more here:
19+
- <https://www.software.ac.uk/blog/2017-12-12-standard-format-citation-files>.
20+
- <https://blog.esciencecenter.nl/cffinit-now-is-the-time-to-get-more-recognition-for-your-software-e2e6ef617f8e>
21+
- <https://the-turing-way.netlify.app/communication/citable/citable-cffinit.html>
1522
- For the Citation File Format specification, go [here](https://github.com/citation-file-format/citation-file-format) (latest) or [here](https://doi.org/10.5281/zenodo.1003149) (stable).
1623
- For the Citation File Format home page, go [here](https://citation-file-format.github.io).
24+
25+
## Information for developers
26+
27+
- If you want to know how you can contribute, please have a look at [the current issues](https://github.com/citation-file-format/cff-initializer-javascript/issues) and read [CONTRIBUTING.md](CONTRIBUTING.md)
28+
- Developer documentation can be found in [README.dev.md](README.dev.md)

0 commit comments

Comments
 (0)