https://github.com/stefandesu/npm-hello-world

Just a repository to test stuff with
https://github.com/stefandesu/npm-hello-world

Last synced: 6 days ago
JSON representation

Just a repository to test stuff with

• Host: GitHub
• URL: https://github.com/stefandesu/npm-hello-world
• Owner: stefandesu
• License: unlicense
• Created: 2020-08-28T11:06:00.000Z (about 4 years ago)
• Default Branch: dev
• Last Pushed: 2020-08-28T12:40:12.000Z (about 4 years ago)
• Last Synced: 2024-08-09T22:09:14.493Z (3 months ago)
• Language: JavaScript
• Size: 172 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# npm-hello-world

Just a repository to test stuff with

## Install

```bash

npm i @stefandesu/hello-world

```

## Usage

```js

const hw = require("@stefandesu/hello-world")

console.log(hw.hello) // prints "world"

console.log(hw.world) // prints "hello"

```

## Test

```bash

git clone https://github.com/stefandesu/npm-hello-world.git

cd npm-hello-world

npm i

npm test

```

## Maintainers

- @stefandesu

## Publish

Please work on the `dev` branch during development (or better yet, develop in a feature branch and merge into `dev` when ready).

When a new release is ready (i.e. the features are finished, merged into `dev`, and all tests succeed), run the included release script (replace "patch" with "minor" or "major" if necessary):

```bash

npm run release:patch

```

This will:

- Switch to `dev`

- Make sure `dev` is up-to-date

- Run `npm version patch` (or "minor"/"major")

- Push changes to `dev`

- Switch to `main`

- Merge changes from `dev`

- Push `main` with tags

- Switch back to `dev`

After running this, GitHub Actions will automatically publish the new version to npm. It will also create a new GitHub Release. Edit the release as necessary.

## Contribute

PRs accepted.

## License

[The Unlicense](https://unlicense.org)