https://github.com/menvia/farol-extension-crossref

https://github.com/menvia/farol-extension-crossref

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/menvia/farol-extension-crossref
• Owner: menvia
• Created: 2019-06-01T03:57:59.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T20:18:07.000Z (10 months ago)
• Last Synced: 2025-02-06T13:44:22.770Z (5 days ago)
• Language: TypeScript
• Size: 218 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Farol Extension for crossreff

## Install

### Using NPM

- To install, run:

  `npm install farol/extension-crossref`

- To update, run:

  `npm update farol/extension-crossref`

## Develop

### NPM

Use `npm link` in the API project repository inside the extensions folder in order to store the link name and path in NPM.

On the project used to develop the library you can run `npm link farol-extension-registration-custom` and it will start using the development version from your API.

## Publish

In order to release a new version you shall follow the steps bellow:

1. Make the desired changes;

2. Update CHANGELOG.md file;

3. Commit your changes;

4. Run the commands below:

- Run

```

  npm version patch

  FAROL_SDK_VERSION=$(npx -c 'echo "$npm_package_version"')

  git commit -am"${FAROL_SDK_VERSION}"

  git tag ${FAROL_SDK_VERSION}

  git push && git push --tags

```