Skip to content

Commit 76adfd7

Browse files
committed
chore: update docs config
1 parent f6e6d15 commit 76adfd7

File tree

3 files changed

+31
-2
lines changed

3 files changed

+31
-2
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Atanda Rasheed
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

lib/elasticlunr.ex

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ defmodule Elasticlunr do
55

66
alias Elasticlunr.{Index, IndexManager, Pipeline}
77

8-
@spec index(atom() | binary()) :: Index.t() | :not_running
8+
@spec index(atom() | binary(), keyword()) :: Index.t() | :not_running
99
def index(name, opts \\ []) do
1010
with opts <- with_default_pipeline([name: name] ++ opts),
1111
index <- Index.new(opts),

mix.exs

+9-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,15 @@ defmodule Elasticlunr.MixProject do
1414
package: package(),
1515
aliases: aliases(),
1616
deps: deps(),
17-
source_url: @source_url
17+
source_url: @source_url,
18+
19+
# Docs
20+
name: "Elasticlunr",
21+
homepage_url: "https://hexdocs.pm/elasticlunr",
22+
docs: [
23+
main: "readme",
24+
extras: ["README.md", "LICENSE"]
25+
]
1826
]
1927
end
2028

0 commit comments

Comments
 (0)