Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
scpedicini committed Dec 20, 2020
1 parent 8c33a79 commit 2744f10
Showing 1 changed file with 14 additions and 18 deletions.
32 changes: 14 additions & 18 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,26 @@
# Truman Show


## Design

<br>
Truman Show is a quick image search program designed to be hotkeyed via AUTOHOTKEY to search the google image repository and copy to clipboard in a fast access manner.<br><br>
## About

Truman Show is a quick image search program designed to be hotkeyed via AUTOHOTKEY to search google image repository and copy to a desired image to the clipboard in a fast accessible manner.

## Getting Started
<br>


### Run the following steps in order:
For newcomers, it is recommended that you download the latest release version and then skip to the "Register" section. However, if you would like to build the project yourself you can follow the instructions below.

<br>
### Run the following commands in order:
1. `git clone https://github.com/scpedicini/truman-show`
2. `npm install`
3. `npm run dist`

1. git clone https://github.com/scpedicini
2. npm install
3. npm run dist

<br>

### Register a custom image search engine with Google
<br>
Truman show requires two API keys, a client id registered to your Google custom search engine, and the secret API key associated with it. These values are pulled directly from the environment variables *CSE_ID* and *CSE_KEY* respectively. It is also recommended that you install a copy of Autohotkey in order to register a global shortcut to easily bring up Truman Show whenever you want to search for images.

Truman show requires two API keys, a client id registered to your [Google custom search engine](https://cse.google.com/cse/all), and the secret API key associated with it. Truman Show attempts to retrieve these values from the environment variables *CSE_ID* and *CSE_KEY* respectively, but can be overridden in the settings page after launching the application. It is also recommended that you install a copy of [Autohotkey](https://www.autohotkey.com) in order to register a global shortcut to easily bring up Truman Show whenever you want to search for images.

Add the following to your autohotkey script AHK file:
Add the following to your autohotkey script (AHK) file:
<pre>
^!H::
Run, "c:/apps/.../dist/truman-show.exe"
Expand All @@ -35,10 +29,12 @@ return

You can now instantly access truman show whenever you type Ctrl-Alt-H.

<br>
### Future Plans

- [ ] Add site(s) to ban list to prevent from showing up in the search (very useful to filter out stock image sites like shutterstock where images typically have watermarks)


## Legal
<br>
Copyright (c) 2020 Specular Realms LLC

Copyright (c) 2020 Specular Realms LLC
https://specularrealms.com

0 comments on commit 2744f10

Please sign in to comment.