https://github.com/moznion/javadocio-badges

Provide badges of javadoc.io
https://github.com/moznion/javadocio-badges

Last synced: 8 months ago
JSON representation

Provide badges of javadoc.io

• Host: GitHub
• URL: https://github.com/moznion/javadocio-badges
• Owner: moznion
• Created: 2015-01-12T04:28:24.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-04-05T03:43:41.000Z (about 10 years ago)
• Last Synced: 2025-01-31T07:34:19.284Z (over 1 year ago)
• Language: Java
• Homepage:
• Size: 272 KB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
javadocio-badges [![Build Status](https://travis-ci.org/moznion/javadocio-badges.svg?branch=master)](https://travis-ci.org/moznion/javadocio-badges)

==

Provides badge of [javadoc.io](http://www.javadoc.io/).

Overview

--

This application is now ready on Heroku.

### Usage

Get page of javadoc.io

    https://javadocio-badges.herokuapp.com/{group_id}/{artifact_id}

Get SVG badge

    https://javadocio-badges.herokuapp.com/{group_id}/{artifact_id}/badge.svg

Example: embedded into markdown

[![javadoc.io](https://javadocio-badges.herokuapp.com/net.moznion/mysql-diff/badge.svg)](https://javadocio-badges.herokuapp.com/net.moznion/mysql-diff)

    [![javadoc.io](https://javadocio-badges.herokuapp.com/net.moznion/mysql-diff/badge.svg)](https://javadocio-badges.herokuapp.com/net.moznion/mysql-diff)

Start the server

--

    DATABASE_URL=postgres://user_name:password@host:port/db_name mvn jetty:run

Creating war file

--

    DATABASE_URL=postgres://user_name:password@host:port/db_name mvn package

How to Deploy to Heroku

--

    DATABASE_URL=postgres://user_name:password@host:port/db_name mvn clean heroku:deploy-war

Execution Option

--

- `maximumLimitOfCacheRow`

Number of maximum rows to limit for caching (why is it needed? => For example, [Heroku Postgres Hobby Dev Plan](https://devcenter.heroku.com/articles/heroku-postgres-plans#hobby-tier)).  

It must be integer value. If this value is not specified, means null, it will be unlimited to cache.

Example;

```

java -DmaximumLimitOfCacheRow=10000 ...

```

Author

--

moznion ()

License

--

MIT