Skip to content

Commit 2387fca

Browse files
committed
update README.md
1 parent d67f5dd commit 2387fca

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
[![License: AGPL v3](https://img.shields.io/github/license/SDM-TIB/ckanext-citation?color=blue)](LICENSE.md)
2+
3+
[![CKAN](https://img.shields.io/badge/ckan-2.10-orange.svg?style=flat-square)](https://github.com/ckan/ckan/tree/2.10) [![CKAN](https://img.shields.io/badge/ckan-2.9-orange.svg?style=flat-square)](https://github.com/ckan/ckan/tree/2.9)
4+
15
# ckanext-citation
26

37
`ckanext-citation` is a multi-format citation export extension for CKAN.
@@ -12,16 +16,16 @@ It adds BibTeX, RIS, EndNote (.enw), APA, ACM Reference Format, and CSL-JSON exp
1216
- ACM Reference Format
1317
- CSL-JSON
1418

15-
## Integration steps
19+
## Installation
20+
21+
As usual for CKAN extensions, you can install `ckanext-citation` as follows:
1622

1723
```bash
18-
source /usr/lib/ckan/default/bin/activate
19-
cd /usr/lib/ckan/default/src
20-
# copy this ckanext-citation/ folder here, then:
21-
pip install -e ckanext-citation/
24+
git clone git@github.com:SDM-TIB/ckanext-citation.git
25+
pip install -e ./ckanext-citation
2226
```
2327

24-
Add `citation` to `ckan.plugins` in your CKAN config, restart CKAN.
28+
Afterward, add `citation` to the plugins in your `ckan.ini`.
2529

2630
## Testing
2731

@@ -31,8 +35,8 @@ pip install -r requirements-test.txt
3135
pytest -v --cov=ckanext.citation --cov-report=term-missing
3236
```
3337

34-
Runs automatically on push/PR via `.github/workflows/test.yml`. See
35-
`tests/README.md` for what is and isn't covered (short version: the
36-
formatter logic is fully unit tested without needing CKAN installed;
37-
there's no Docker/Postgres/Solr integration job against a real CKAN
38-
instance yet).
38+
The formatter logic is fully unit tested without needing CKAN installed; there is no Docker/Postgres/Solr integration job against a real CKAN instance yet (see `tests/README.md`).
39+
40+
## License
41+
42+
`ckanext-citation` is licensed under AGPL-3.0, see the [license file](LICENSE.md).

0 commit comments

Comments
 (0)