Skip to content

Commit

Permalink
chore(docs): update readme with badges (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
forest authored May 20, 2022
1 parent f18e1de commit 88f4351
Showing 1 changed file with 17 additions and 33 deletions.
50 changes: 17 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,33 @@
# Snowpack

[![CI](https://github.com/HGInsights/snowpack/actions/workflows/elixir-ci.yml/badge.svg)](https://github.com/HGInsights/snowpack/actions/workflows/elixir-ci.yml)
[![hex.pm version](https://img.shields.io/hexpm/v/snowpack.svg)](https://hex.pm/packages/snowpack)
[![hex.pm license](https://img.shields.io/hexpm/l/snowpack.svg)](https://github.com/HGInsights/snowpack/blob/main/LICENSE)
[![Last Updated](https://img.shields.io/github/last-commit/HGInsights/snowpack.svg)](https://github.com/HGInsights/snowpack/commits/main)


<!-- MDOC !-->

Snowflake driver for Elixir.

Documentation: <https://hginsights.github.io/snowpack>

## Features

- Automatic decoding and encoding of Elixir values to and from Snowflake's ODBC driver formats
- Supports transactions, prepared queries, streaming, pooling and more via
[DBConnection](https://github.com/elixir-ecto/db_connection)
- Supports transactions, prepared queries, pooling and more via [DBConnection](https://github.com/elixir-ecto/db_connection)
- Supports Snowflake ODBC Drivers 2.24.7+

## TODO

- Support streaming via [DBConnection](https://github.com/elixir-ecto/db_connection)

## Usage

Add `:snowpack` to your dependencies:

```elixir
def deps() do
[
{:snowpack, "~> 0.5.0"}
{:snowpack, "~> 0.6.0"}
]
end
```
Expand Down Expand Up @@ -105,37 +110,16 @@ Notes:

<!-- MDOC !-->

## Contributing
## Documentation

Run tests:
Documentation is automatically published to
[hexdocs.pm](https://hexdocs.pm/snowpack) on release. You may build the
documentation locally with

```
git clone git@github.com:HGInsights/snowpack.git
cd snowpack
mix deps.get
mix test
```

Working with [Earthly](https://earthly.dev/) for CI

MIX_ENV=docs mix docs
```
brew install earthly

earthly +static-code-analysis
earthly --secret SNOWPACK_SERVER="my-account.snowflakecomputing.com" --secret-file SNOWPACK_PRIV_KEY=./rsa_key.p8 +test
```

## License

The source code is under Apache License 2.0.

Copyright (c) 2022 HG Insights

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
License. You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
## Contributing

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
language governing permissions and limitations under the License.
Issues and PRs are welcome! See our organization [CONTRIBUTING.md](https://github.com/HGInsights/.github/blob/main/CONTRIBUTING.md) for more information about best-practices and passing CI.

0 comments on commit 88f4351

Please sign in to comment.