Merge pull request #83 from davidwebster48/master

Fix typos and improve docs

README.md

@@ -26,7 +26,7 @@ Edit your app's config.exs to add the list of Mnesia stores:
 
 ```elixir
 config :mnesiac,
-  stores: [Mnesiac.ExampleStore, ...],
+  stores: [MyApp.ExampleStore, ...],
   schema_type: :disc_copies, # defaults to :ram_copies
   table_load_timeout: 600_000 # milliseconds, default is 600_000
 ```
@@ -83,7 +83,7 @@ There are three optional callbacks which can be implemented:
 - `copy_store/0`, which allows users to implement a custom call to copy a store. Triggered by Mnesiac.
 - `resolve_conflict/1`, which allows a user to implement logic when Mnesiac detects a store with records on both the local and remote Mnesia cluster node. Triggered by Mnesiac. Default is to do nothing.
 
-**_MINIMAL EXAMPLE:_**:
+**_MINIMAL EXAMPLE:_**
 
 ```elixir
 defmodule MyApp.ExampleStore do
@@ -96,7 +96,7 @@ defmodule MyApp.ExampleStore do
   @doc """
   Record definition for ExampleStore example record.
   """
-  Record.defrecord(
+  defrecord(
     :example,
     __MODULE__,
     id: nil,
@@ -118,7 +118,7 @@ defmodule MyApp.ExampleStore do
   @impl true
   def store_options,
     do: [
-      record_name: __MODULE__,
+      record_name: :example,
       attributes: example() |> example() |> Keyword.keys(),
       index: [:topic_id],
       ram_copies: [node()]

SECURITY.md

@@ -6,4 +6,4 @@ As it currently stands, this project does not have a supported version other tha
 
 ## Reporting a Vulnerability
 
-If you discover a vulnerability in the Mnesiac codebase, please email the details and method to reproduce to [email protected]. You should expect a response within 48 - 72 hours, with followups as nessasary. If the vulnerability is accepted, an advisory will be drafted for it for Mnesiac and an issue to fix it will be created, if possible. If the issue turns out to be caused by an underlying library or language, an issue will be filed with them. You should expect a response with steps taken whether the vulnerability is accepted or declined.
+If you discover a vulnerability in the Mnesiac codebase, please email the details and method to reproduce to [email protected]. You should expect a response within 48 - 72 hours, with followups as necessary. If the vulnerability is accepted, an advisory will be drafted for it for Mnesiac and an issue to fix it will be created, if possible. If the issue turns out to be caused by an underlying library or language, an issue will be filed with them. You should expect a response with steps taken whether the vulnerability is accepted or declined.

lib/mnesiac/store.ex

@@ -4,8 +4,8 @@ defmodule Mnesiac.Store do
   """
 
   @doc """
-  This function returns ths store's configuration as a keyword list.
-  For more information on the options supported here, see mnesia's documenatation.
+  This function returns the store's configuration as a keyword list.
+  For more information on the options supported here, see mnesia's documentation.
   ## Examples
   ```elixir
   iex> store_options()