From efd7e000701201ee830d272310e6e47e0ebc2b13 Mon Sep 17 00:00:00 2001 From: Decio Ferreira Date: Sun, 8 Dec 2024 15:49:02 +0000 Subject: [PATCH] update README with install and publish sections --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 8651fde61..9eb366fad 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,16 @@ This phase will foster a unified ecosystem that adapts to the needs of its users Our ultimate goal is to create a language that inherits the best aspects of Elm while adapting and growing to meet the needs of its users. +# Install + +To install Guida as an npm package, run the following command: + +``` +npm install -g guida +``` + +You should now be able to run `guida --version`. + # Development Start by installing [Node Version Manager](https://github.com/nvm-sh/nvm). @@ -121,6 +131,32 @@ npm run test:elm-format-validate npm run elm-format ``` +# Publish new npm package version + +Before publishing a new npm package version, make sure you are on the correct +branch, ie. in case of wanting to publish a 0.x version, you should have the +`v0.x` branch checked out. + +To publish a new version, we should then run the following commands: + +``` +npm version +npm publish +git push origin +git push origin tag v +``` + +As an example, these should have been the commands ran for publishing `v0.2.0-alpha` + +``` +npm version 0.2.0-alpha +npm publish +git push origin v0.x +git push origin tag v0.2.0-alpha +``` + +The `` value relates to the `version` field value found on `package.json`. + # References - Initial transpilation from Haskell to Elm done based on [Elm compiler v0.19.1](https://github.com/elm/compiler/releases/tag/0.19.1)