Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.94 KB
Raw

Contributing

Contributions are welcome! This guide attempts to answer common question about how the project works.

Getting Started

  • Clone this repo to <Vault>/.obsidian/plugins/obsidian-instapaper/
  • Make sure your NodeJS is at least v16 (node --version)
  • Add your API Credentials to a local .env file
  • npm i or yarn to install dependencies
  • npm run dev to start compilation in watch mode
  • Reload Obsidian to discover the plugin
  • Enable the Instapaper plugin in the Obsidian Settings window

You might also want to install the Hot-Reload plugin to automatically reload the code during development.

Manual Installation

If you need to manually install a copy of this plugin, copy the main.js and manifest.json files to your vault (e.g. <Vault>/.obsidian/plugins/obsidian-instapaper/).

API Credentials

You'll need your own pair of Instapaper API OAuth credentials to use the API.

Add them to a local .env file:

INSTAPAPER_CONSUMER_KEY=xxx
INSTAPAPER_CONSUMER_SECRET=xxx

ESLint

ESLint is used to maintain code quality. To run it over the entire project:

npm run lint

Releases

  1. Run npm version patch, npm version minor or npm version major to automatically package.json, manifest.json, and versions.json.
  2. Create a new GitHub release using the new version as the "Tag version" (exactly, without a v prefix).
  3. Upload the files manifest.json and main.js as binary attachments. Note: The manifest.json file must be in two places: the root path of the repository and also in the release.
  4. Publish the release.

Also make sure that minAppVersion in manifest.json always reflects the minimum required Obsidian version expected by the plugin code.

License

By contributing to this project, you agree that your contributions will be licensed under its license.