diff --git a/README.md b/README.md index de4ef9a..55b4c4c 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,67 @@ Exploring the use of digital badges for crediting contributors to scholarly pape As the research environment becomes more digital, we want to test how we can use this medium to help bring transparency and credit for individuals in the publication process. -This work is a collaboration with publishers [BioMed Central](http://www.biomedcentral.com/) (BMC), [Ubiquity Press](http://www.ubiquitypress.com/) (UP) and the [Public Library of Science](http://www.plos.org/) (PLoS); the biomedical research foundation, [The Wellcome Trust](http://www.wellcome.ac.uk/); the software and technology firm [Digital Science](http://www.digital-science.com/); the registry of unique researcher identifiers, [ORCID](http://orcid.org/); and the [Mozilla Science Lab](http://mozillascience.org/). +## Using Paper Badger + +You can display contributorship badges for science on your own site! Researchers earn badges for their specific contributions to an academic paper. A researcher who worked on investigation earns a prestigious investigation badge for that paper. + +The PaperBadger widget enables *anyone*, from publishers to individual researchers, to easily display badges on a website by including just a few lines of script with the relevant doi (digital object identifier) and a designated `
` in your view file. Authors can add the script to their own sites to display badges earned, while publishers can use the script to display all badges associated with a paper: + +![Badge Preview](./public/img/badge_preview.jpg) + +1. To use the widget on your own site, include a `
` with your custom class in your view file, for example: + `
` + +2. Above the closing `` tag, add + ```html + + ``` -![Proposed Workflow / Implementation](./public/img/Badges-ProposedWorkflow.jpg) +3. In your scripts, include your custom values: + * the class name where your widget will appear for the `container-class` key and + * the doi for the paper you are interested in as the `article-doi` key + +```html + + + + + Paper view snippet example | Paper Badger + + + +
+ + + + + +``` + +## Contributing + +[Project Roadmap: #17](https://github.com/mozillascience/paperbadger/issues/17) + +Want to help? We love new contributors! Please review our [contributing guidelines](CONTRIBUTING.md) and take a look at some [good first bugs](https://github.com/mozillascience/PaperBadger/labels/good%20first%20bug). ### Getting Started +Are you ready to contribute to Paper Badger? This section will help you set up your own development version of the Contributorship Badges prototype. + Clone PaperBadger and enter the directory: `git clone https://github.com/mozillascience/PaperBadger && cd PaperBadger` #### Run using Docker @@ -59,63 +113,10 @@ If you would like to develop against the hosted custom badgekit-api we have runn export ORCID_AUTH_TOKEN_PATH=############# export ORCID_REDIRECT_URI=############# -Ask @acabunoc for ones marked `###########`. Our custom BadgeKit API code can be found [here](https://github.com/acabunoc/badgekit-api). +Ask [@acabunoc](http://github.com/acabunoc) for ones marked `###########`. Our custom BadgeKit API code can be found [here](https://github.com/acabunoc/badgekit-api). * Run `npm start`, and open up `http://localhost:5000/` in your favourite web browser! -### Using the Widget -Researchers earn badges for their specific contributions to an academic paper. A researcher who worked on investigation earns a prestigious investigation badge for that paper. - -The PaperBadger widget enables anyone to easily display badges on any website by including just a few lines of script with the relevant doi (digital object identifier) and a designated `
` in your view file. Authors can add the script to their own sites to display badges earned, while publishers can use the script to display all badges associated with a paper: - -![Badge Preview](./public/img/badge_preview.jpg) - -1. To use the widget on your own site, include a `
` with your custom class in your view file, for example: - `
` - -2. Above the closing `` tag, add - - - -3. In your scripts, include your custom class name as the value for the "container-class" key, for example: - -```html - - - - - Paper view snippet example | Paper Badger - - - -
- - - - - -``` - -### Contributing - -[Project Roadmap: #17](https://github.com/mozillascience/paperbadger/issues/17) - -Please review our contributing guidelines [here](CONTRIBUTING.md) - -Want to help? Drop us a line in [this issue](https://github.com/mozillascience/PaperBadger/issues/2). ### API Endpoints @@ -144,3 +145,8 @@ Want to help? Drop us a line in [this issue](https://github.com/mozillascience/P * e.g. [/papers/10.1186/2047-217X-3-18/users/0000-0001-5979-8713/badges/data_curation](http://badges.mozillascience.org/papers/10.1186/2047-217X-3-18/users/0000-0001-5979-8713/badges/data_curation) * POST /papers/:doi1/:doi2/badges/:orcid/badges/:badge * Issue a badge + +*** + +This work is a collaboration with publishers [BioMed Central](http://www.biomedcentral.com/) (BMC), [Ubiquity Press](http://www.ubiquitypress.com/) (UP) and the [Public Library of Science](http://www.plos.org/) (PLoS); the biomedical research foundation, [The Wellcome Trust](http://www.wellcome.ac.uk/); the software and technology firm [Digital Science](http://www.digital-science.com/); the registry of unique researcher identifiers, [ORCID](http://orcid.org/); and the [Mozilla Science Lab](http://mozillascience.org/). +