Skip to content
This repository has been archived by the owner on May 5, 2023. It is now read-only.

Commit

Permalink
fix: mention style tweaks in README
Browse files Browse the repository at this point in the history
  • Loading branch information
paulbricman authored Sep 18, 2021
1 parent f4c5e65 commit d3ec5b4
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,14 @@ This will make your conceptarium available at `127.0.0.1:8000`.

# Usage


**Note**: If you want to access your conceptarium remotely, you might want to have a look at [ngrok](https://ngrok.com/) and expose local port 8000 to the world via a URL.

Out of the box, the conceptarium exposes endpoints for all relevant interactions which can be accessed through a browser. However, for power users, a host of endpoints are exposed which return JSONs, plain text, image files, and others, rather than web pages. Those can be used to set up the conceptarium as a browser search engine, for creating [AutoKey](https://github.com/autokey/autokey) / [AutoHotKey](https://www.autohotkey.com/) scripts, for setting up [IFTTT](https://ifttt.com/) integrations, and others.
Out of the box, the conceptarium exposes endpoints for all relevant interactions which can be accessed through a browser (see mockups below). However, for power users, a host of endpoints are exposed which return JSONs, plain text, image files, and others, rather than web pages. Those can be used to set up the conceptarium as a browser search engine, for creating [AutoKey](https://github.com/autokey/autokey) / [AutoHotKey](https://www.autohotkey.com/) scripts, for setting up [IFTTT](https://ifttt.com/) integrations, and others.

**Please find the complete auto-generated API docs over at `127.0.0.1:8000/docs`.**

The style and color scheme of your conceptarium can be tweaked via `assets/style.css`.

![mockuper](https://user-images.githubusercontent.com/20104026/133883441-0faae359-9335-46bf-b10c-27ebb8c274b3.png)
![mockuper(1)](https://user-images.githubusercontent.com/20104026/133883445-b26de5d2-cd71-4a7f-8c0d-99ae25da2865.png)
![mockuper(2)](https://user-images.githubusercontent.com/20104026/133883515-37e7853f-171e-4760-bf03-a2fc557dc364.png)

0 comments on commit d3ec5b4

Please sign in to comment.