Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maciejwalkowiak committed Dec 12, 2022
1 parent 7448be9 commit fc9f1f3
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Just 🚀

**Just** is a smart zero config command line interface for running Spring Boot applications in development mode (and more).

Its goal is to speed up developing applications with Spring Boot by automating common activities that occur during development.

[🌍 Project Website](https://just.maciejwalkowiak.com/) | [📗 Documentation](https://just.maciejwalkowiak.com/)

## 🛠 How to install

On MacOS:

```
$ brew install maciejwalkowiak/brew/just
```

On Windows:

```
$ scoop install maciejwalkowiak/just
```

More details & Linux installation steps: https://just.maciejwalkowiak.com/docs/install/

## 🏃‍♂️ How to use

In the terminal go to your project directory and execute:

```
$ just run
```

More information in [documentation](https://just.maciejwalkowiak.com/docs/usage/just-run/) including other commands: `just build`,
`just format`, `just kill`.

## 🙏 How to help

Try it out, play with your projects and whenever you find an issue please file it here:
https://github.com/maciejwalkowiak/just/issues


0 comments on commit fc9f1f3

Please sign in to comment.