Skip to content

Commit

Permalink
Chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
regadas committed Dec 7, 2022
1 parent 490e938 commit cecd1f9
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,17 @@

Flyte Flink k8s plugin.

# Contents
## Contents

- [About](#About)
- [Dependencies](#Dependencies)
- [Building](#Building)
- [Testing](#Testing)
- [License](#License)
- [flyte-flink-plugin](#flyte-flink-plugin)
- [Contents](#contents)
- [About](#about)
- [Dependencies](#dependencies)
- [Building](#building)
- [Testing](#testing)
- [License](#license)

# About
## About

Current development status:

Expand All @@ -29,26 +31,26 @@ Current development status:

To learn more about Flyte refer to:

- [Flyte homepage](https://flyte.org)
- [Flyte master repository](https://github.com/lyft/flyte)
- [Flyte homepage](https://flyte.org)
- [Flyte master repository](https://github.com/lyft/flyte)

# Dependencies
## Dependencies

To install the project dependencies, run:

```shell
go mod install
```

# Building
## Building

To build ginary, run:
To build the binary, run:

```
```sh
make build
```

# Testing
## Testing

To run tests, run:

Expand All @@ -62,6 +64,6 @@ To run tests with coverage, run:
go test -v -covermode=count ./...
```

# License
## License

This project is released under the [Apache License 2.0](./LICENSE).

0 comments on commit cecd1f9

Please sign in to comment.