Skip to content

Commit

Permalink
fix: delete ; from taxi.proto and remove docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tiero committed Dec 11, 2021
1 parent ef24933 commit 27a00f6
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 838 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ jobs:
run: make buf

- name: Commit generated stubs
continue-on-error: true
run: |
git config --local user.email "$(git log --format='%ae' HEAD^!)"
git config --local user.name "$(git log --format='%an' HEAD^!)"
git add generated
git add docs
git commit -m "Automated: Update protobuf stubs"
git push
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Vulpem Ventures

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 1 addition & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,4 @@

buf:
buf generate

doc:
docker run --rm -v `pwd`/docs:/out -v `pwd`:/protos pseudomuto/protoc-gen-doc
docker run --rm -v `pwd`/docs:/out -v `pwd`:/protos pseudomuto/protoc-gen-doc --doc_opt=markdown,docs.md

13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,15 @@
* Docker (for docgen)


## Compile stubs
## Compile

```bash
make buf
# or with buf directly
buf generate
```


## Documentation

Automatically generate HTML and Markdown documentation (Docker running is required)

```sh
$ make doc
```

## Usage
## Install

### Go

Expand Down
162 changes: 0 additions & 162 deletions docs/docs.md

This file was deleted.

Loading

0 comments on commit 27a00f6

Please sign in to comment.