diff --git a/README.md b/README.md index 94cb83b..1edd4ae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Wollok-TS-CLI -[![Build CI](https://github.com/uqbar-project/wollok-ts-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/uqbar-project/wollok-ts-cli/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/uqbar-project/wollok-ts-cli/graph/badge.svg?token=rpJA6VlVJo)](https://codecov.io/gh/uqbar-project/wollok-ts-cli) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![Build CI](https://github.com/uqbar-project/wollok-ts-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/uqbar-project/wollok-ts-cli/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/uqbar-project/wollok-ts-cli/graph/badge.svg?token=rpJA6VlVJo)](https://codecov.io/gh/uqbar-project/wollok-ts-cli) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![npm version](https://badge.fury.io/js/wollok-ts-cli.svg)](https://badge.fury.io/js/wollok-ts-cli) 🖖 Welcome to the Wollok Command Line Interface! @@ -23,6 +23,8 @@ This is the list of the currently available commands: Go to [latest release](https://github.com/uqbar-project/wollok-ts-cli/releases/latest), download the executable based on your operating system and add it to the PATH (here are instructions to do so in [Mac](https://apple.stackexchange.com/questions/41542/adding-a-new-executable-to-the-path-environment-variable), [Windows](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53) and [Linux](https://unix.stackexchange.com/questions/183295/adding-programs-to-path)). +Or install it using [npm](https://www.npmjs.com/package/wollok-ts-cli) with the command `npm i -g wollok-ts-cli`. You must have [NodeJS](https://nodejs.org/) installed in your local machine. + Feel free to report issues on [the project's issue tracker](https://github.com/uqbar-project/wollok-ts-cli/issues). This component is part of the [Wollok language project](https://github.com/uqbar-project/wollok-language) where you can have an overall picture of our roadmap. diff --git a/package.json b/package.json index 6e3e2e4..425dd45 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "wollok-ts-cli", - "version": "0.2.2", + "version": "0.2.3", "description": "Wollok Command Line Interface", "repository": "https://github.com/uqbar-project/wollok-ts-cli", "license": "MIT", @@ -8,6 +8,15 @@ "name": "Uqbar Foundation", "email": "org.uqbar@gmail.com" }, + "bugs": { + "url": "https://github.com/uqbar-project/wollok-ts-cli/issues" + }, + "homepage": "https://github.com/uqbar-project/wollok-language", + "keywords": [ + "wollok", + "cli", + "typescript" + ], "main": "./build/src/index.js", "scripts": { "preinstall": "sh scripts/download-libs.sh", @@ -19,7 +28,8 @@ "test:unit": "mocha --parallel -r ts-node/register/transpile-only test/**/*.test.ts --timeout 7000", "build": "shx rm -rf build && shx mkdir ./build && shx cp -r ./public ./build/public && tsc -p ./tsconfig.build.json", "watch": "npm run build -- -w", - "pack": "pkg ." + "pack": "pkg .", + "prepublishOnly": "npm run build && npm run test" }, "bin": { "wollok": "./build/src/index.js" diff --git a/src/index.ts b/src/index.ts index 8dead01..d47ae1a 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,3 +1,4 @@ +#!/usr/bin/env node import { Command } from 'commander' import repl from './commands/repl' import run from './commands/run'