Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aledeg committed May 26, 2018
1 parent 87a8e94 commit e2a3ad9
Showing 1 changed file with 48 additions and 4 deletions.
52 changes: 48 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,51 @@
# linkdump

## What it does
## What's that?

It allows to add links to a storage and then dump that storage as a text file.
This text file can be used later on as an input file for tools like wget or
youtube-dl.
Linkdump is a Firefox extension which allows you to store links, URL, and bookmarks
in the local storage until you are ready to dump them in a file. At the moment, raw
text files, markdown files, and HTML files are supported.

## How do I add entries in the storage?

There is different ways to add entries in the storage. At the moment, only the
following are available:
1. URL are added by clicking the ![Linkdump icon](icons/linkdump-16.png) icon
available in the address bar.
1. Link are added by clicking the ![Linkdump icon](icons/linkdump-16.png) icon
available in the link context menu.
1. Bookmarks are added by clicking the ![Linkdump icon](icons/linkdump-16.png)
icon available in the bookmark context menu
1. Bookmark folders are added recursively by clicking the
![Linkdump icon](icons/linkdump-16.png) icon available in the bookmark folder
context menu.

## How do I retrieve the storage content?

The first thing to do is to display the storage content by clicking the
![Linkdump icon](icons/linkdump-16.png) button available in the interface.
Doing so will display the content and the available actions.

The default download action will dump the storage content into a text file. But
you can select another download action to suit your needs.

When the download action is finished, the storage is cleared.

## How is this useful?

If you want to download a bunch of videos, you can dump links in a text file and
use that file as input for *[youtube-dl](https://rg3.github.io/youtube-dl/)*.
```
youtube-dl --batch-file linkdump.txt
youtube-dl -a linkdump.txt
```

If you want to download a bunch of files, you can dump links in a text file and
use that file as input for *[wget](https://www.gnu.org/software/wget/)*.
```
wget --input-file linkdump.txt
wget -i linkdump.txt
```

If you want to add a list of links in your blog, you can dump links in a markdown
file and use that file as a starting point for your post.

0 comments on commit e2a3ad9

Please sign in to comment.