mirror of
https://github.com/daniel-j/fimfic2epub.git
synced 2024-05-18 19:33:38 +12:00
add readme, bump version
This commit is contained in:
parent
ff4c0416af
commit
863b58daa2
36
README.md
Normal file
36
README.md
Normal file
|
@ -0,0 +1,36 @@
|
|||
fimfic2epub
|
||||
===========
|
||||
|
||||
This is a tool to generate better EPUB ebooks from [fimfiction](http://www.fimfiction.net/) stories. It's also a Chrome/Firefox extension, replacing the default EPUB download option with this tool.
|
||||
|
||||
|
||||
Usage (browser extension)
|
||||
-----------------
|
||||
|
||||
You can download the Chome extension from [Chrome Web Store](https://chrome.google.com/webstore/detail/fimfic2epub/fiijkoniocipeemlflajmmaecfhfcand).
|
||||
|
||||
Right now the addon is not available in Add-ons for Firefox, but it's fully compatible.
|
||||
|
||||
|
||||
Installation & usage (command line)
|
||||
-------------------
|
||||
|
||||
You can install the tool by running `npm install -g daniel-j/fimfic2epub`. You can then run it with `$ fimfic2epub <story id>`. This will save the EPUB in the current working directory.
|
||||
|
||||
Example:
|
||||
# Download Tag Test by McPoodle
|
||||
$ fimfic2epub 180690
|
||||
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
Make sure [Node.js](https://nodejs.org) is installed. After you've cloned this repository, run `npm install` and `npm run build` to build it. This project uses [gulp](http://gulpjs.com/).
|
||||
|
||||
|
||||
Development
|
||||
-----------
|
||||
|
||||
Make sure [gulp is installed](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md).
|
||||
|
||||
When working on the code and testing it in a web browser as an extension, you can run gulp in watch mode: `gulp watch`. This will lint code and build it when you save. To build, just run `gulp` or `npm run build`. To lint, run `gulp lint` and to clean, run `gulp clean`.
|
|
@ -4,7 +4,7 @@
|
|||
"name": "fimfic2epub",
|
||||
"short_name": "fimfic2epub",
|
||||
"description": "Improved EPUB exporter for Fimfiction",
|
||||
"version": "1.0.3",
|
||||
"version": "1.0.4",
|
||||
|
||||
"icons": {
|
||||
"128": "icon-128.png"
|
||||
|
|
11
package.json
11
package.json
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "fimfic2epub",
|
||||
"private": true,
|
||||
"version": "1.0.3",
|
||||
"version": "1.0.4",
|
||||
"description": "",
|
||||
"author": "djazz",
|
||||
"scripts": {
|
||||
|
@ -11,20 +11,24 @@
|
|||
"fimfic2epub": "./bin/fimfic2epub.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"babel-register": "^6.11.6",
|
||||
"babel-preset-node6": "^11.0.0",
|
||||
"detect-node": "^2.0.3",
|
||||
"escape-string-regexp": "^1.0.5",
|
||||
"file-saver": "^1.3.2",
|
||||
"html-entities": "^1.2.0",
|
||||
"image-size": "^0.5.0",
|
||||
"jszip": "^3.0.0",
|
||||
"mithril": "^0.2.5",
|
||||
"pretty-data": "^0.40.0",
|
||||
"request": "^2.72.0",
|
||||
"stylus": "^0.54.5",
|
||||
"tidy-html5": "^0.1.1",
|
||||
"zero-fill": "^2.2.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"babel-core": "^6.9.1",
|
||||
"babel-loader": "^6.2.4",
|
||||
"babel-preset-node6": "^11.0.0",
|
||||
"del": "^2.2.0",
|
||||
"exports-loader": "^0.6.3",
|
||||
"gulp": "^3.9.1",
|
||||
|
@ -34,13 +38,10 @@
|
|||
"gulp-util": "^3.0.7",
|
||||
"gulp-watch": "^4.3.8",
|
||||
"gulp-zip": "^3.2.0",
|
||||
"image-size": "^0.5.0",
|
||||
"lazypipe": "^1.0.1",
|
||||
"raw-loader": "^0.5.1",
|
||||
"request": "^2.72.0",
|
||||
"run-sequence": "^1.2.1",
|
||||
"standard": "^7.1.2",
|
||||
"stylus": "^0.54.5",
|
||||
"stylus-loader": "^2.1.1",
|
||||
"webpack": "^2.1.0-beta.13"
|
||||
},
|
||||
|
|
Loading…
Reference in a new issue