diff --git a/README.md b/README.md index c06868a..778a490 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,9 @@ _Note: Official documentation for contexted library is [available on hexdocs][he - [Installation](#installation) - [Step by step overview](#step-by-step-overview) - [Keep contexts separate](#keep-contexts-separate) + - [Exclude files and folders from check context cross-references](#exclude-files-and-folders-from-check-context-cross-references) - [Dividing each context into smaller parts](#dividing-each-context-into-smaller-parts) - [Being able to access docs and specs in auto-delegated functions](#being-able-to-access-docs-and-specs-in-auto-delegated-functions) - - [Exclude files and folders from check context cross-references](#exclude-files-and-folders-from-check-context-cross-references) - [Don't repeat yourself with CRUD operations](#dont-repeat-yourself-with-crud-operations) - [Contributing](#contributing) - [License](#license) @@ -104,7 +104,7 @@ def project do end ``` -Next, define a list of contexts available in the app inside _config.exs_: +Next, define a list of contexts available in the app inside config file: ```elixir config :contexted, contexts: [ @@ -124,6 +124,17 @@ Read more about `Contexted.Tracer` and its options in [docs](https://hexdocs.pm/
+#### Exclude files and folders from check context cross-references + +In special cases, you may need to exclude certain folders or files from cross-reference checks due to project structure or naming conventions. To do this, add a list of exclusions in config `exclude_paths` option: + +```elixir +config :contexted, + exclude_paths: ["app/test"] +``` + +
+ ### Dividing each context into smaller parts To divide big Context into smaller Subcontexts, we can use `delegate_all/1` macro from `Contexted.Delegator` module. @@ -199,17 +210,6 @@ Read more about `Contexted.Delegator` and its options in [docs](https://hexdocs.
-#### Exclude files and folders from check context cross-references - -Inside your `config.exs` you can add list of files and folders to exclude from checking context cross-references: - -```elixir -config :contexted, - exclude_paths: ["app/test", "app/lib/app/account.ex"] -``` - -
- ### Don't repeat yourself with CRUD operations In most web apps CRUD operations are very common. Most of these, have the same pattern. Why not autogenerate them?