BookStack Code Mirror - api-scripts/blob - chrome-extension-google-search-results/readme.md

   1 # BookStack in Google Search Results Chrome Extension
   2
   3 This is a very rough and simplistic example of a Google chrome extension that will inject BookStack
   4 search results into the page when making google.com searches.
   5
   6 **This is only meant as an example or foundation**, it is not a fully featured/finished/tested extension.
   7 The styles are quite bad and it may be prone to breaking. I am not looking to improve or expand this extension
   8 so PRs, unless minor issue fixes, will not be accepted.
   9
  10 If you look to build this out into a proper chrome-store extension, please don't use the "BookStack" name
  11 or logo alone and make it clear your extension is unofficial.
  12
  13 ## Requirements
  14
  15 You will need a Chrome (or Chromium based browser) instance where you can enable developer mode in extensions.
  16 You will also need BookStack API credentials (TOKEN_ID & TOKEN_SECRET) at the ready.
  17
  18 ## Usage
  19
  20 This extension is not on the app store but you can side-load it with relative ease.
  21 Within chrome:
  22
  23 - Go to "Manage Extensions"
  24 - Toggle "Developer mode" on.
  25 - Click the "Load unpacked" option.
  26 - Select this folder.
  27
  28 You will need to configure the extension options and fill in your BookStack instance API details.
  29 You can get to this by right-clicking the extension in the top of the browser and clicking "Options", or via "Manage Extension" > Click "Details" on the extension > "Extension Options".