https://github.com/esipfed/esip_badger
modified static badge generator (based on slackin and shields.io)
https://github.com/esipfed/esip_badger
Last synced: 10 months ago
JSON representation
modified static badge generator (based on slackin and shields.io)
- Host: GitHub
- URL: https://github.com/esipfed/esip_badger
- Owner: ESIPFed
- License: mit
- Created: 2015-08-26T03:36:50.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-04-25T22:00:58.000Z (about 8 years ago)
- Last Synced: 2024-01-24T18:02:47.303Z (over 2 years ago)
- Language: Python
- Size: 132 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
ESIP Badger
===========
##ESIP Badge Design
This is the initial round of possible badges for the ESIP community. The structure and styles are based on the shields.io project (public domain) and a de facto standard for Github badging.
We have three collections, one for getting at ESIP funded (or supported) things, one for the relationship to ESIP, and one for the collaboration areas/clusters. For funding/supported, the tags are Funded, FUNding Friday and Testbed. For the relationships, it's Member and Collaborator.
The API is very simple. There's a single URL with the structure:
> http://badge.esipfed.org/{badge-type}.svg?style={display-style}
**OR**
> http://badge.esipfed.org/{user}/{repository}/{badge-type}.svg?style={display-style}
where `funded` is one of the supported badge types, `user` is the Github account and `repository` is the repository name.
Using it in one's documentation is as simple as adding:
```
```
to the Markdown (as an `img` element or through another available SVG rendering method).
That method will only render the image without any links. To include a link to the ESIP site, use:
```
```
modifying the SVG request as necessary. That displays as: 
The `display` query parameter provides the option to display the ESIP logo on the left side:
```
```
generating: 
####Parameter Options
**badge-type:** funded | testbed | fundingfriday | member | collaborator
**display-style:** flat-round (default) | plastic | flat-square
**display-option:** logo | text (default)
**user:** Github user name
**repository:** repository name
`account` and `repo` are accepted for basic analytic purposes only, ex:
> http://badge.esipfed.org/roomthily/esip_badger/fundingfriday.svg
**Values for Collaboration Areas
- agclimate : Agriculture & Climate
- cleannetwork: The Clean Network
- climateed : Climate Education
- cloud : Cloud Computing
- datasteward : Data Stewardship
- datastudy : Data Study
- disasters : Disasters
- discovery : Discovery
- documentation : Documentation
- drones : Drones
- drupal : Drupal
- esda : Earth Science Data Analytics
- education : Education
- energyclimate : Energy & Climate
- envirosensing : Envirosensing
- infoquality : Information Quality
- infotech : Information Technology & Interoperability
- libraries : Libraries
- products : Products & Services
- scicomm: Science Communication
- sciencesoftware : Science Software
- semanticweb : Semantic Web
- sustainabledata : Sustainable Data Management
- usability: Usability
- visioneers : Visioneers
- webservices : Web Services
####Text Examples
| Rounded | Plastic | Flat |
|:--------|:--------|:-----|
| | 
| 
|
| 
| 
| 
|
| 
| 
| 
|
| 
| 
| 
|
| 
| 
| 
|
####Logo Examples
| Rounded | Plastic | Flat |
|:--------|:--------|:-----|
| | 
| 
|
| 
| 
| 
|
| 
| 
| 
|
| 
| 
| 
|
| 
| 
| 
|
####Notes
It is not pixel-perfect compared to the shields.io badges (server-side python estimation without typeface info). Nor is it pixel-perfect between terms.
The URL in the provided examples are volatile while testing. Use at your own risk (or, better, not at all just yet).
Installation
============
Refer to [INSTALL](INSTALL.md) for the details.
Acknowledgements
================
This project is supported by an ESIP Federation FUNding Friday award, Summer Meeting 2015.
Based on [badges/shields](https://github.com/badges/shields) and [rauchg/slackin](https://github.com/rauchg/slackin).
License
=======
MIT