Do you have a large collection of PDF books, journal articles and research papers? Shelf (aka bookshelf) will help you bring order to chaos! It gives you:
- Content based search that beats Windows, MacOS, and Linux desktop search
- Utilities to help you keep file names consistent, manage metadata, and convert files between formats
- Extensible plugin architecture so that you can add your own bling
Install the application in your local environment:
npm install -g @elmarquez/shelf
Once installed, a script will be installed at:
/usr/local/bin/shelf
Display help information:
shelf --help
Requires NodeJS 12. Install all application dependencies:
npm install
Run the test suite:
npm test
Update the package version number, commit and tag the update:
npm release
shelf is a community driven, open source project. We accept pull requests for new features and bug fixes. Please see the CODE_OF_CONDUCT.md file for rules governing participation in the project.
To participate, start by taking a look at our project kanban for information on planned features and work in progress.
https://github.com/users/elmarquez/projects/1
This project is made available under the MIT License. See the LICENSE file for details.