https://github.com/menvia/farol-extension-fs-os

Farol Extension - OS
https://github.com/menvia/farol-extension-fs-os

Last synced: 2 days ago
JSON representation

Farol Extension - OS

• Host: GitHub
• URL: https://github.com/menvia/farol-extension-fs-os
• Owner: menvia
• Created: 2019-03-19T20:38:35.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-20T19:50:29.000Z (almost 6 years ago)
• Last Synced: 2025-01-17T04:30:13.958Z (25 days ago)
• Language: JavaScript
• Size: 1.95 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • Changelog: CHANGELOG.MD

Awesome Lists containing this project

README

        
# Farol Extension for Lahar

## Install

### Using NPM

- To install, run:

  `npm install farol-extension-fs-os`

- To update, run:

  `npm update farol-extension-fs-os`

## 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-fs-os` 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

```