Gurkengewuerz/ImgScroll
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README: Markdown formatting, update links to point to GitHub resources.

Browse Source
This commit is contained in:
metaprime 2016-12-20 04:06:26 -08:00
parent f13de34e69
commit f247ad1297
1 changed files with 25 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,4 +1,5 @@
# RipMe
[![Build Status](https://travis-ci.org/4pr0n/ripme.svg?branch=master)](https://travis-ci.org/4pr0n/ripme)
[![Join the chat at https://gitter.im/4pr0n-ripme/Lobby](https://badges.gitter.im/4pr0n-ripme/Lobby.svg)](https://gitter.im/4pr0n-ripme/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@ -6,20 +7,23 @@ Album ripper for various websites. Runs on your computer. Requires Java 1.6
![Screenshot](http://i.imgur.com/kWzhsIu.png)
[Download v1.x](http://rarchives.com/ripme.jar) (ripme.jar)
--------------------------
For information about running the `.jar` file, see [the How To Run wiki](https://github.com/4pr0n/ripme/wiki/How-To-Run-RipMe)
## [Downloads](https://github.com/4pr0n/ripme/releases)
[Changelog](http://rarchives.com/ripme.json) (ripme.json)
--------------
Download `ripme.jar` from the [latest release](https://github.com/4pr0n/ripme/releases).
Features
---------------
For information about running the `.jar` file, see [the How To Run wiki](https://github.com/4pr0n/ripme/wiki/How-To-Run-RipMe).
## [Changelog](https://github.com/4pr0n/ripme/blob/1.3.0/ripme.json) (ripme.json)
## [Website](http://rip.rarchives.com/)
# Features
* Quickly downloads all images in an online album (see supported sites below)
* Easily re-rip albums to fetch new content
Supported sites:
## Supported sites:
* imgur
* twitter
* tumblr
@ -38,14 +42,19 @@ Supported sites:
* xhamster
* (more)
[Full updated list](https://github.com/4pr0n/ripme/issues/8)
### [Full updated list](https://github.com/4pr0n/ripme/issues/8)
Request more sites by adding a comment to [this Github issue](https://github.com/4pr0n/ripme/issues/8) or by following the wiki guide [How To Create A Ripper for HTML Websites](https://github.com/4pr0n/ripme/wiki/How-To-Create-A-Ripper-for-HTML-websites)
## Not Supported?
Compiling & Building
--------------------
Request support for more sites by adding a comment to [this Github issue](https://github.com/4pr0n/ripme/issues/8).
The project uses [Maven](http://maven.apache.org/). To build the .jar file using Maven, navigate to the root project directory and run:
If you're a developer, you can add your own by following the wiki guide
[How To Create A Ripper for HTML Websites](https://github.com/4pr0n/ripme/wiki/How-To-Create-A-Ripper-for-HTML-websites).
# Compiling & Building
The project uses [Maven](http://maven.apache.org/).
To build the .jar file using Maven, navigate to the root project directory and run:
```bash
mvn clean compile assembly:single
@ -53,8 +62,7 @@ mvn clean compile assembly:single
This will include all dependencies in the JAR.
Running Tests
-------------
# Running Tests
After building you can run tests by running the following:
@ -62,8 +70,8 @@ After building you can run tests by running the following:
mvn test
```
Dependencies
------------
# Dependencies
* junit-3.8.1
* jsoup-1.7.3
* json-20140107