Skip to content

Commit

Permalink
add deps to opam file and instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
chrismamo1 committed Mar 12, 2023
1 parent 98b3e69 commit d4a1944
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,21 @@ This OCaml package is automatically generated by the [OpenAPI Generator](https:/

## Requirements.

OCaml 4.x
OCaml >4

## Installation

Please run the following commands to build the package `openapi`:

I haven't bothered to put this in the public OPAM repo just yet since I'm not sure if it's ready for prime time.

```sh
opam install ppx_deriving_yojson cohttp ppx_deriving cohttp-lwt-unix pin ocaml-migrate-parsetree 1.3.1
eval $(opam env)
dune build
opam pin add openai .
```

## Getting Started

TODO
Your openai API key should go in the `OPENAI_API_KEY` environment variable.

Please see the example for basic usage of the chat completion API. Other API's are not dissimilar.

12 changes: 11 additions & 1 deletion openai.opam
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,15 @@ license: ""
homepage: ""
bug-reports: ""
dev-repo: ""
depends: [ "ocaml" "ocamlfind" ]
depends: [
"ocaml"
"ocamlfind"
"ppx_deriving_yojson"
"ppx_deriving.show"
"ppx_deriving.eq"
"ppx_deriving.ord"
"ppx_deriving.std"
"ez_api.ppx"
"lwt_ppx"
]
build: ["dune" "build" "-p" name]

0 comments on commit d4a1944

Please sign in to comment.