Skip to content

Commit

Permalink
doc: Add Goa clue example information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ikawaha committed Oct 14, 2023
1 parent 772a41a commit d9ffbdc
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,15 @@ $ cd basic
```

A [fully instrumented example](https://github.com/goadesign/clue/tree/main/example/weather) of a
system consisting of multiple Goa microservices is included in the
[Clue](https://github.com/goadesign/clue) repo.
system consisting of multiple Goa microservices is included in the [Clue](https://github.com/goadesign/clue) repo.

To get started with the Goa Clue example, you can use the gonew command to clone it into your own repository:

```shell
$ gonew github.com/goadesign/clue/example/weather github.com/<your_repo>/weather
$ cd weather
```
Please follow the README in the Clue repository for more details on running and testing the Goa Clue example.

As you study each example consider contributing back by providing better or more complete docs,
adding clarifying comments to code or fixing any error you may run across!

0 comments on commit d9ffbdc

Please sign in to comment.