Skip to content

Commit

Permalink
update README with install and publish sections
Browse files Browse the repository at this point in the history
  • Loading branch information
decioferreira committed Dec 8, 2024
1 parent 87be0b2 commit efd7e00
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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 <newversion>
npm publish
git push origin <currentbranch>
git push origin tag v<newversion>
```

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 `<newversion>` 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)
Expand Down

0 comments on commit efd7e00

Please sign in to comment.