Skip to content
This repository was archived by the owner on Dec 8, 2024. It is now read-only.

fabienvauchelles/shaarli-java-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 

Repository files navigation

shaarli-java-api

shaarli-java-api is a java client api for Sebsauvage's Shaarli.

You can find a tutorial here (in french).

Why use shaarli ?

It's KISS.

Why use shaarli-java-api ?

Just a few reasons :

  • it's KISS (again, it's boring?) ;
  • it's fast (based on Apache Http Client) ;
  • it's easy to deploy with Maven ;
  • it's safe (with unit tests, a code control with Checkstyle, PMD and Findbugs) ;

Which features can i use ?

You can :

  • Iterate all links (and reverse) ;
  • Iterate links by multiple tags (and reverse) ;
  • Iterate links by a term (and reverse) ;
  • Count links ;
  • Add a new post ;
  • Modify an existing post ;
  • Delete an existing post ;
  • Define your own hooks to use a customized Shaarli (like lesliensducode.com).

How to use it ?

  1. Add this to your pom.xml file :
    <dependency>
      <groupId>com.vaushell.shaarli-java-api</groupId>
      <artifactId>shaarli-java-api</artifactId>
      <version>REPLACE_WITH_LAST_VERSION</version>
    </dependency>
    
  2. See this tutorial here (in french) ;
  3. See example file here ;
  4. See unit tests here ;
  5. Do it in your code !

Licence

See LICENCE.txt.

About

shaarli-java-api is a java client for Sebsauvage's Shaarli

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages