Skip to content

Commit 887bb34

Browse files
committed
Added 'Customization' section to the README
1 parent 6d7bf63 commit 887bb34

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,3 +188,25 @@ configuration, it should be no surprise that there is a fair amount of logic
188188
around that. Configuration logic is not very useful for a code reference,
189189
so the majority of that logic is encapsulated here to keep other code
190190
references clean.
191+
192+
## Customization
193+
194+
It should be feasible to use this project as a starting point for your
195+
own implementation. Here are a few places to look to make changes:
196+
197+
- The styles for the entire project can be found in [src/styles](src/styles).
198+
Simple style tweaks changes can be made here, or you could replace these styles
199+
with your own.
200+
- [src/components](src/components) contains the view templates for
201+
components. Structural HTML changes can be made here.
202+
- If you find that you have different data or behavior requirements for
203+
existing components, you can customize the component Containers in
204+
[src/containers](src/containers).
205+
- If you find you have requirements that none of the existing components
206+
satisfy, you could create an entirely new component and/or container. Use the
207+
`withAppSearch` HOC in order to access any action or state.
208+
- Lastly, if you find there is a core action or state missing, you may
209+
consider updating the core logic in [src/app-search](src/app-search).
210+
211+
Lastly, we accept PRs! If you make a customization that you think would benefit
212+
others, please feel free to contribute it back.

0 commit comments

Comments
 (0)