Skip to content

Commit e204cc5

Browse files
Initial readme instructions
1 parent 068e98e commit e204cc5

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# Impervious Releases
22

3+
This is the repository for impervious releases and supporting files and documentation.
4+
5+
## Binaries
6+
TODO
7+
8+
## Docs
9+
10+
Markdown docs for the API's may be viewable in `/dbcs` for each service. There is a nice format of these docs imported into https://docs.impervious.ai as well.
11+
12+
You may also see the docs on your Imp deamon by accessing it through the http proxy. By default: `localhost:8882/docs`
13+
14+
## GRPC
15+
16+
The Imp daemon API's can be accessible with both GRPC and HTTP. For accessing via GRPC, you may utilize the proto files located at `/proto/` of this repo. We have also generated a few client libraries so you can get started much faster by using them in your project. For now we support: `go` & `js` but if there's another language you'd like generated client libraries for, please let us know.
17+
18+
## OpenAPI
19+
20+
We also supply OpenAPIv2 files so that you may import them into your own tools, whether that's postman or something like https://editor.swagger.io
21+
22+
These files are split up by service and can be accessible at `/openapiv2/`
23+
24+
## Sample Config
25+
26+
We have a base config file you may build off of to run with your Imp deamon. Copy `config.yml` to a location next to your deamon, fill in the blanks, and you can run with `impd --config=config.yml`.
27+
28+
More info on the config can be found here: https://docs.impervious.ai/#impervious-node-configuration
29+

0 commit comments

Comments
 (0)