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

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dustin Blackman committed Dec 8, 2016
1 parent 13c2eba commit cdcfe40
Show file tree
Hide file tree
Showing 12 changed files with 85 additions and 92 deletions.
2 changes: 1 addition & 1 deletion BACKERS.md
@@ -1,7 +1,7 @@
# Backers

Thank you to all the wonderful backers and supporters who keeps this project alive and helps bring more to the League of
Legends community. If you'd like to help support Championify, check out my Patreon. https://patreon.com/dustinblackman
Legends community. If you'd like to help support Championify, check out my Patreon. [https://patreon.com/dustinblackman](https://patreon.com/dustinblackman)

| Name | Support |
| ------------- | -----:|
Expand Down
79 changes: 53 additions & 26 deletions CHANGELOG.md
@@ -1,13 +1,40 @@
# Changelog

<a name="2.0.0" />
## 2.0.0 (Month Day, Year)

#### Breaking Changes
- Completely replaced auto updater with [Squirrels](https://github.com/electron/electron/blob/master/docs/api/auto-updater.md) (built in to Electron) causing anything below 2.0.0 to break. Manual reinstallation required. [#205](https://github.com/dustinblackman/Championify/issues/205)
- Renamed `--startLeague` option parameter to `--start-league`

#### Features
- Added op.gg, Probuilds, and Lolalytics
- Changed donation method to Patreon [#151](https://github.com/dustinblackman/Championify/issues/151)
- Updated translations

#### Bug Fixes
- Added Control wards to consumables [#223](https://github.com/dustinblackman/Championify/issues/223)
- Fixed Wukong not showing up for some sources [#211](https://github.com/dustinblackman/Championify/issues/211)
- Fixed incorrect translation placement [#216](https://github.com/dustinblackman/Championify/issues/216)
- Replaced Windows elevate with standalone exe [#220](https://github.com/dustinblackman/Championify/issues/220)
- Fixed error message when Windows can't elevate
- Fixed error window being hidden and showing successful builds instead
- Fixed versions view to support more sources

#### Technical Features
- Updated to Node 6 / Electron 1.4.10
- Both Windows and macOS are now code signed to secure builds and updates [#123](https://github.com/dustinblackman/Championify/issues/123)
- Improved development experience on OSX
- Replaced Jade with Marko for faster renders

<a name="1.3.8" />
### 1.3.8 (November 14th, 2016)
## 1.3.8 (November 14th, 2016)

#### Updates
- Added Control Ward

<a name="1.3.7" />
### 1.3.7 (November 3rd, 2016)
## 1.3.7 (November 3rd, 2016)

#### Bug Fixes
- Fixed some KoreanBuilds not showing up in game due to misnamed folders
Expand All @@ -16,19 +43,19 @@
- Updated translations

<a name="1.3.6" />
### 1.3.6 (August 24th, 2016)
## 1.3.6 (August 24th, 2016)

#### Bug Fixes
- Removed BG and NL from supported Riot languages. Defaults to English.

<a name="1.3.5" />
### 1.3.5 (July 29th, 2016)
## 1.3.5 (July 29th, 2016)

#### Fixes
- Hours after removing Lolflavor which had been down for weeks, it's now returned.

<a name="1.3.4" />
### 1.3.4 (July 28th, 2016)
## 1.3.4 (July 28th, 2016)

#### Bug Fixes
- Lolflavor is dead, remove from the app
Expand All @@ -38,27 +65,27 @@
- Fix missing blue trinket from all item sets

<a name="1.3.3" />
### 1.3.3 (April 6th, 2016)
## 1.3.3 (April 6th, 2016)

#### Notes
- Disabled LeagueOfGraphs

<a name="1.3.2" />
### 1.3.2 (April 6th, 2016)
## 1.3.2 (April 6th, 2016)

#### Bug Fixes
- Fixed bug when install path isn't correctly set and throws an error instead of a warning
- Fixed health pots missing
- Fixed duplicate items

<a name="1.3.1" />
### 1.3.1 (April 6th, 2016)
## 1.3.1 (April 6th, 2016)

#### Bug Fixes
- Fix preferences not being loaded correctly after updating.

<a name="1.3.0" />
### 1.3.0 (April 6th, 2016)
## 1.3.0 (April 6th, 2016)

#### Features
- Added KoreanBuilds and LeagueOfGraphs as sources
Expand Down Expand Up @@ -91,62 +118,62 @@


<a name="1.2.11" />
### 1.2.11 (March 26th, 2016)
## 1.2.11 (March 26th, 2016)

#### Bug Fixes
- Fix inconsistent ID format for Champions

<a name="1.2.10" />
### 1.2.10 (February 1st, 2016)
## 1.2.10 (February 1st, 2016)

#### Bug Fixes
- Disable changing languages during import

<a name="1.2.9" />
### 1.2.9 (Janurary 30th, 2016)
## 1.2.9 (Janurary 30th, 2016)

#### Bug Fixes
- Added Arabic and Japanese to a whitelist so that it defaults to English when in game, gets rid of block text.

<a name="1.2.8" />
### 1.2.8 (Janurary 26th, 2016)
## 1.2.8 (Janurary 26th, 2016)

#### Bug Fixes
- Lolflavor import failing due to missing Nami item sets

<a name="1.2.7" />
### 1.2.7 (Janurary 2nd, 2016)
## 1.2.7 (Janurary 2nd, 2016)

#### Bug Fixes
- Disabled `causedBy` error on updates once and for all.

<a name="1.2.6" />
### 1.2.6 (Janurary 2nd, 2016)
## 1.2.6 (Janurary 2nd, 2016)

#### Updates
- Disabled `Send Log`
- Updated Translations

<a name="1.2.5" />
### 1.2.5 (December 14th, 2015)
## 1.2.5 (December 14th, 2015)

#### Bug Fixes
- Fixed `causedBy` error

<a name="1.2.4" />
### 1.2.4 (December 13th, 2015)
## 1.2.4 (December 13th, 2015)

#### Updates
- Updated translations

<a name="1.2.3" />
### 1.2.3 (November 26th, 2015)
## 1.2.3 (November 26th, 2015)

#### Bug Fixes
- Another temporary fix for users with `Unexpected end of input` and `roles` errors

<a name="1.2.2" />
### 1.2.2 (November 25th, 2015)
## 1.2.2 (November 25th, 2015)

#### Bug Fixes
- Temporary fix for users with `Unexpected end of input` errors
Expand All @@ -155,13 +182,13 @@
- Updated translations

<a name="1.2.1" />
### 1.2.1 (November 24th, 2015)
## 1.2.1 (November 24th, 2015)

#### Bug Fixes
- Fix Champion.gg 404 error

<a name="1.2.0" />
### 1.2.0 (November 20th, 2015)
## 1.2.0 (November 20th, 2015)

#### Features
- Added Arabic
Expand All @@ -175,19 +202,19 @@
- Updated translations

<a name="1.1.2" />
### 1.1.2 (November 3rd, 2015)
## 1.1.2 (November 3rd, 2015)

#### Updates
- Updated translations

<a name="1.1.1" />
### 1.1.1 (October 23rd, 2015)
## 1.1.1 (October 23rd, 2015)

#### Updates
- Updated translations

<a name="1.1.0" />
### 1.1.0 (October 13th, 2015)
## 1.1.0 (October 13th, 2015)

#### Features
- Added 13 new languages. Bosnian, Catalan, Croatian, Danish, Finnish, Georgian, Lithuanian, Latvian, Norwegian, Slovak, Slovenian, Serbian, and Swedish.
Expand All @@ -201,13 +228,13 @@


<a name="1.0.3" />
### 1.0.3 (October 10th, 2015)
## 1.0.3 (October 10th, 2015)

#### Bug Fixes
- Fixed infinite loop on updates for Windows

<a name="1.0.2" />
### 1.0.2 (October 8th, 2015)
## 1.0.2 (October 8th, 2015)

#### Bug Fixes
- Fixed translation issue with ARAM item sets fail due to antivirus
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTE.md
Expand Up @@ -7,7 +7,7 @@ JSDocs for the majority of functions can be found [here](https://doclets.io/dust

__Rules__

- Everything is in ES6 Javascript with the Node 4 presets. That means `const` and `let`, everything for example.
- Everything is in ES6 Javascript with the Node 6 presets. That means `const` and `let`, everything for example.
- New features must be discussed in an issue first before a PR, this prevents wasting anyones time incase it's already being worked on.
- Reframe from adding new npm modules if there's already something that'll get the job done.
- Must pass all tests. `npm test`
Expand Down
6 changes: 1 addition & 5 deletions FAQ.md
Expand Up @@ -24,10 +24,6 @@ Due to Riot restrictions, you can only see the item sets in game, you won't see
Sorry, Electron doesn't support anything below Windows 7 or Mountain Lion. There's no plans to support it.


#### "App can’t be opened because it is from an unidentified developer"
Read [this](http://osxdaily.com/2012/07/27/app-cant-be-opened-because-it-is-from-an-unidentified-developer/) to fix it.


#### The app opens with a white box, infinite loops, I just see the background, or nothing happens
I'm a bit lost why this is happening on some system, as I haven't found any real way to track it or recreate it myself. Delete the following folders depending on your operating system, and then try Championify again.

Expand All @@ -50,7 +46,7 @@ Oh no not at all, that's the last thing you want to do. The best time to run Cha


#### Why do you force auto updates of Championify?
If something was to change on Riots end and Championify's item sets broke your client or completely screwed up one of your games, you'd be pretty pissed right? I know I would be. This is just one method to make sure you run in to the least amount of problems possible, plus the updates are under ~8MB anyway.
If something was to change on Riots end and Championify's item sets broke your client or completely screwed up one of your games, you'd be pretty pissed right? I know I would be. This is just one method to make sure you run in to the least amount of problems possible.


#### How do I auto update item sets?
Expand Down

0 comments on commit cdcfe40

Please sign in to comment.