Skip to content

Commit

Permalink
feat: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bossm0n5t3r committed May 4, 2024
1 parent dfc8f17 commit 7dbca21
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 8 deletions.
31 changes: 23 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,33 @@
# Microsearch

To start your Phoenix server:
- `microsearch` is a minimalistic Elixir search engine.
- It's based on [microsearch](https://github.com/alexmolas/microsearch).
- You can visit [https://microsearch.fly.dev/](https://microsearch.fly.dev/) to see it in action. However, it may take some time if the server is down and running again.

* Run `mix setup` to install and setup dependencies
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
## Pages

![main.png](./images/main.png)

![search_result.png](./images/search_result.png)

## TO-DO

- [ ] Modify download contents to function properly
- [ ] Modify search results to be accurate

## To start your Phoenix server:

- Run `mix setup` to install and setup dependencies
- Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`

Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.

Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).

## Learn more

* Official website: https://www.phoenixframework.org/
* Guides: https://hexdocs.pm/phoenix/overview.html
* Docs: https://hexdocs.pm/phoenix
* Forum: https://elixirforum.com/c/phoenix-forum
* Source: https://github.com/phoenixframework/phoenix
- Official website: https://www.phoenixframework.org/
- Guides: https://hexdocs.pm/phoenix/overview.html
- Docs: https://hexdocs.pm/phoenix
- Forum: https://elixirforum.com/c/phoenix-forum
- Source: https://github.com/phoenixframework/phoenix
Binary file added images/main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/search_result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7dbca21

Please sign in to comment.