@@ -0,0 +1,60 @@
1+# Installation Instructions
2+
3+1. Create a folder and name it whatever you want.
4+
5+```bash
6+$ mkdir seax-project
7+$ cd seax-project
8+```
9+2. Inside the folder, `clone` the **airlock** library and the **seax** project.
10+
11+```bash
12+$ git clone https://github.com/ilyakooo0/airlock
13+$ git clone https://github.com/ilyakooo0/seax
14+```
15+3. Download the v2.11 pill.
16+
17+```bash
18+$ wget https://bootstrap.urbit.org/urbit-v2.11.pill
19+```
20+4. Start your fake zod using the pill.
21+
22+```bash
23+$ urbit -B urbit-v2.11.pill -F zod
24+```
25+
26+5. Now, inside dojo run the following:
27+```bash
28+dojo> |new-desk %seax
29+dojo> |mount %seax
30+```
31+
32+6. Back in your shell, run:
33+```bash
34+$ rm -r zod/seax
35+$ cp -r seax/zod/seax zod/seax
36+```
37+
38+7. In the dojo install the seax agent and allow cross-site origin requests from localhost.
39+```bash
40+dojo> |commit %seax
41+dojo> |install our %seax
42+dojo> |pass [%e [%approve-origin 'http://localhost:8000']]
43+```
44+
45+8. While your urbit is running in another terminal run:
46+```bash
47+$ ./seax/dev/elm-live.sh
48+```
49+The above command will start the frontend which communicates with your zod ship
50+using the Elm airlock library.
51+
52+Now, you can go to your browser at `http://localhost:8000/`.
53+The seax app should be displaying a search bar. You might need to refresh the page once before using the app.
54+You'll know that everything works if you see the "< ~zod: Opening airlock!" message in your dojo.
55+
56+# Usage Instructions
57+
58+Now, you can fill in the search bar with any term you like.
59+Clicking "search" will iniate collect any relevant results from the configured search sources.
60+In the results page, you can click on any of the sources to filter to only results from that source.