Skip to content

Commit

Permalink
more instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
solidiquis committed Apr 8, 2024
1 parent 84acab9 commit fa72d77
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
12 changes: 11 additions & 1 deletion examples/go/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Sift Go Example

To run this example ensure that you have Go and the [buf CLI](https://buf.build/docs/installation) installed.
To run this example ensure that you have Go and the [buf CLI](https://buf.build/docs/installation) installed as well as having your
Sift API key ready. If you need a Sift API key please refer to [these instructions](https://help.siftstack.com/en/articles/8600475-api-keys).

Once those are installed and your working directory is this project's root, compile the protobufs:

Expand All @@ -14,6 +15,15 @@ Install dependencies:
$ go get -d ./...
```

Create your `.env` file:

```bash
$ cp .env-example .env
```

Be sure to set the appropriate environment variables in your `.env` file depending on the environment you're using. Comments
meant to serve as guides can be found in the `.env-example` file.

Now execute the program by providing the partial string of the annotations you wish to query. In the following example
we'll be querying for all annotations whose name matches the `voltage` substring in a case-insensitive manner.

Expand Down
12 changes: 11 additions & 1 deletion examples/rust/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
# Sift Rust Example

To run this example ensure that you have Rust and the [buf CLI](https://buf.build/docs/installation) installed.
To run this example ensure that you have Go and the [buf CLI](https://buf.build/docs/installation) installed as well as having your
Sift API key ready. If you need a Sift API key please refer to [these instructions](https://help.siftstack.com/en/articles/8600475-api-keys).

Once those are installed and your working directory is this project's root, compile the protobufs:

```bash
$ buf generate protos
```

Create your `.env` file:

```bash
$ cp .env-example .env
```

Be sure to set the appropriate environment variables in your `.env` file depending on the environment you're using. Comments
meant to serve as guides can be found in the `.env-example` file.

Now execute the program by providing the partial string of the annotations you wish to query. In the following example
we'll be querying for all annotations whose name matches the `voltage` substring in a case-insensitive manner.

Expand Down

0 comments on commit fa72d77

Please sign in to comment.