diff --git a/README.md b/README.md index 8baac45..c8fa047 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ -# Archivator +# [Archivator][repo-url] -**CURRENT STATUS**: Under **heavy** development, *but now usable* see [renoirb/archivator-demo](https://github.com/renoirb/archivator-demo). +> Ever wanted to archive your own copy of articles you enjoyed reading +> and to be able to search through them? -Ever wanted to archive your own copy of articles you enjoyed reading -and to be able to search through them? +| Version | Size | Dependencies | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [![npm](https://img.shields.io/npm/v/archivator?style=flat-square&logo=appveyor&label=npm&logo=npm)](https://www.npmjs.com/package/archivator) | ![npm bundle size](https://img.shields.io/bundlephobia/min/archivator?style=flat-square) | ![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/archivator?style=flat-square&logo=appveyor&logo=dependabot) | + +__CURRENT STATUS__: This is frozen __v1.x__ branch, [future work is under __v3.x-dev__ branch][third-rewrite], __but usable as-is__ see [renoirb/archivator-demo][archivator-demo] + +[repo-url]: https://github.com/renoirb/archivator +[homepage]: https://github.com/renoirb/archivator/tree/v3.x-dev#third-rewrite +[archivator-demo]: https://github.com/renoirb/archivator-demo + +## Summary This project is a means to try out ECMAScript 2017 tooling and do something useful. See [Challenge](#challenge) below. diff --git a/package.json b/package.json index 5a4455e..ed87c0d 100644 --- a/package.json +++ b/package.json @@ -1,25 +1,44 @@ { "name": "archivator", "version": "1.0.0", - "description": "Fetch and stream body contents for URLs", + "description": "Ever wanted to archive your own copy of articles you enjoyed reading and to be able to search through them?", + "homepage": "https://github.com/renoirb/archivator/tree/v3.x-dev#third-rewrite", "repository": { "type": "git", - "url": "git@github.com:renoirb/archivator.git" + "url": "https://github.com/renoirb/archivator.git" }, - "bugs": { - "url": "https://github.com/renoirb/archivator/issues" + "license": "MIT", + "author": { + "name": "Renoir Boulanger", + "email": "contribs@renoirboulanger.com" }, + "files": [ + "dist", + "README.md" + ], "scripts": { + "analyze": "babel-node src/analyze.js", + "archive": "babel-node src/archive.js", "dist": "babel src/ --minified -d dist/ -s", - "test": "node_modules/.bin/mocha --compilers js:babel-core/register", + "fix": "node_modules/.bin/xo --fix", "lint": "node_modules/.bin/xo", - "watch": "babel src/ -d dist/ -w -s", - "archive": "babel-node src/archive.js", - "analyze": "babel-node src/analyze.js", - "fix": "node_modules/.bin/xo --fix" + "test": "node_modules/.bin/mocha --compilers js:babel-core/register", + "watch": "babel src/ -d dist/ -w -s" + }, + "xo": { + "esnext": true, + "ignores": [ + "dist/**", + "example.js" + ], + "plugins": [ + "unicorn" + ], + "rules": { + "func-names": 0 + }, + "space": 2 }, - "author": "Renoir Boulanger (http://renoirb.com/)", - "license": "MIT", "dependencies": { "async-file": "^2.0.2", "babel-polyfill": "^6.23.0", @@ -44,19 +63,5 @@ "eslint-plugin-unicorn": "^1.0.0", "mocha": "^3.2.0", "xo": "^0.17.1" - }, - "xo": { - "esnext": true, - "space": 2, - "plugins": [ - "unicorn" - ], - "ignores": [ - "dist/**", - "example.js" - ], - "rules": { - "func-names": 0 - } } } diff --git a/yarn.lock b/yarn.lock index c847e7d..8a65ba3 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2127,10 +2127,6 @@ map-obj@^1.0.0, map-obj@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/map-obj/-/map-obj-1.0.1.tgz#d933ceb9205d82bdcf4886f6742bdc2b4dea146d" -maybe@0.0.2: - version "0.0.2" - resolved "https://registry.yarnpkg.com/maybe/-/maybe-0.0.2.tgz#aef4f97e17074ab1cd92b492f6c52f93cf6c9c26" - meow@^3.4.2: version "3.7.0" resolved "https://registry.yarnpkg.com/meow/-/meow-3.7.0.tgz#72cb668b425228290abbfa856892587308a801fb"