Skip to content

Commit 444e7c3

Browse files
committed
refine documentation
1 parent 60af061 commit 444e7c3

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
[Hex](https://hex.pm/packages/sql_kit) | [GitHub](https://github.com/tylerbarker/sql_kit) | [Documentation](https://hexdocs.pm/sql_kit)
44

5-
Execute raw SQL using files or strings, automatically get maps and structs back. Built on top of ecto_sql.
5+
Execute raw SQL in strings or .sql files, automatically get maps and structs back. Built on top of ecto_sql.
66

7-
SqlKit provides two ways to execute raw SQL with automatic result transformation:
7+
SqlKit provides two ways to execute SQL with automatic result transformation:
88

99
1. **Direct SQL execution** - Execute SQL strings directly with any Ecto repo
1010
2. **File-based SQL** - Keep SQL in dedicated files with compile-time embedding

lib/sql_kit.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# credo:disable-for-this-file Credo.Check.Refactor.LongQuoteBlocks
22
defmodule SqlKit do
33
@moduledoc """
4-
Execute raw SQL using files or strings, automatically get maps and structs back. Built on top of ecto_sql.
4+
Execute raw SQL in strings or .sql files, automatically get maps and structs back.
55
6-
SqlKit provides two ways to execute raw SQL with automatic result transformation:
6+
SqlKit provides two ways to execute SQL with automatic result transformation:
77
88
## Direct SQL Execution
99

mix.exs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ defmodule SqlKit.MixProject do
1919
homepage_url: "https://hex.pm/packages/sql_kit",
2020
source_url: "https://github.com/tylerbarker/sql_kit",
2121
description: """
22-
A SQL toolkit for Elixir with automatic result transformation to maps and structs.
22+
Execute raw SQL in strings or .sql files, automatically get maps and structs back.
2323
"""
2424
]
2525
end

0 commit comments

Comments
 (0)