Skip to content

Commit

Permalink
Added a quickstart guide [#5]
Browse files Browse the repository at this point in the history
  • Loading branch information
mcpierce committed Mar 26, 2024
1 parent 920b6e5 commit 557ff1d
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 0 deletions.
25 changes: 25 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Installing The ComicVine Metadata Adaptor

1. Download the latest release bundle from [here](https://github.com/comixed/comixed-metadata-comicvine/releases).
1. Extract the **comixed-metadata-comicvine-*.jar** file from the archive.
1. Copy this file to your ```$HOME/.comixed/extensions``` directory.
1. Restart your ComiXed server.


# Configuring The Adaptor

1. You need to first get a [ComicVine API Key](https://comicvine.gamespot.com/api/).
1. Go to the **Configuration** page.
1. Open the **Metadata Sources** tab.
1. In the list of available sources you should see the following:
![metadata sources list](images/metadata-source-list.png)
1. Click on the entry for **ComicVineMetadataAdaptor** and a dialog box will appear:
![properties dialog](images/metadata-properties-dialog-1.png)
1. Click on the **Add Property** button.
1. Create a new property with a property name of **comic-vine.api-key**.
1. For the property value enter your API key.
![properties dialog](images/metadata-properties-dialog-2.png)
1. **Optional** mark this as your preferred metadata source.
1. Click the **Save** button.

You should now be able to scrape comics using the ComicVine database!
Binary file added images/metadata-properties-dialog-1.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/metadata-properties-dialog-2.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/metadata-source-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/main/assembly/src.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
<includes>
<include>CHANGELOG.md</include>
<include>CONTRIBUTORS.md</include>
<include>INSTALLATION.md</include>
<include>LICENSE</include>
<include>README.md</include>
<include>CHANGELOG.md</include>
Expand Down

0 comments on commit 557ff1d

Please sign in to comment.