Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kjellberg authored Apr 4, 2023
1 parent 8e21cb5 commit 26abc4c
Showing 1 changed file with 24 additions and 22 deletions.
46 changes: 24 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@

Monoz is a command-line tool that helps you manage your **ruby** monorepo. It provides an easy way to manage multiple related **ruby** projects and their dependencies in a single repository. Monoz helps you keep track of your projects and their interdependencies, making it easier to maintain and scale your codebase.

## Installation
## Getting started

You can install Monoz by running the following command:

```console
$ gem install monoz
```

## Getting started

To initialize a Monoz repository in the current directory, simply run:

```console
Expand All @@ -29,6 +27,8 @@ This will create a new Monoz repo with the following structure:
└── monoz.yml
```

## Projects

### Adding projects

Once you've initialized your Monoz repository, you can start adding projects to it.
Expand Down Expand Up @@ -102,6 +102,27 @@ Error: The command bundle exec rubocop failed to run in one or more project dire

This will execute the `bundle exec rubocop` command in each project directory, ensuring that all the necessary dependencies are installed and loaded for each project. Similarly, you can run other bundler commands such as `bundle install`, `bundle update`, and so on, by appending the desired arguments to the `monoz bundle` command.

### Projects overview

You can inspect the projects in your Monoz repository using the `monoz projects` command. This command will display a table that shows the projects in the repository, their type (app or gem), the gem name (if it's a gem), the test framework(s) used, and the projects that depend on them.

Here's an example output of the `monoz projects` command:

```console
$ monoz projects

o---------------o--------o-------------o---------------------o-------------------------------------o
| Project | Type | Gem Name | Test Framework(s) | Dependants |
o---------------o--------o-------------o---------------------o-------------------------------------o
| content_api | app | | rspec | |
| core_api | app | | rspec | |
| kiqr_cloud | app | | rspec | |
| kiqr_core | gem | kiqr_core | rspec | content_api, core_api, kiqr_cloud |
o---------------o--------o-------------o---------------------o-------------------------------------o
```

## Runing commands

### Running commands in projects

You can run any command in all projects of your Monoz repository using the `monoz run` command. Simply provide the command you want to run as an argument, and Monoz will execute it in each project directory.
Expand Down Expand Up @@ -191,25 +212,6 @@ Finally, you can also specify individual project names in the filter expression.
$ monoz run rubocop --filter="gem1,gem2"
```

### List projects

You can inspect the projects in your Monoz repository using the `monoz projects` command. This command will display a table that shows the projects in the repository, their type (app or gem), the gem name (if it's a gem), the test framework(s) used, and the projects that depend on them.

Here's an example output of the `monoz projects` command:

```console
$ monoz projects

o---------------o--------o-------------o---------------------o-------------------------------------o
| Project | Type | Gem Name | Test Framework(s) | Dependants |
o---------------o--------o-------------o---------------------o-------------------------------------o
| content_api | app | | rspec | |
| core_api | app | | rspec | |
| kiqr_cloud | app | | rspec | |
| kiqr_core | gem | kiqr_core | rspec | content_api, core_api, kiqr_cloud |
o---------------o--------o-------------o---------------------o-------------------------------------o
```

## Contributing
We welcome contributions from everyone! If you're interested in contributing to Monoz, please check out our contributing guidelines for more information.

Expand Down

0 comments on commit 26abc4c

Please sign in to comment.