Skip to content

Commit

Permalink
Merge pull request #140 from animal-crossing-music-extension/readme-u…
Browse files Browse the repository at this point in the history
…pdate

Small readme updates
  • Loading branch information
PikaDude authored Aug 10, 2020
2 parents 30d5b6e + 0a43971 commit d0ee68c
Showing 1 changed file with 3 additions and 21 deletions.
24 changes: 3 additions & 21 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
![Project Banner](docs/banner.png)

# Animal Crossing Music 🍀

**Animal Crossing Music** is a fun Chrome extension for playing Animal Crossing's music in the browser, while you work, play or browse the web! ✨

The music updates in real-time on the hour, and informs you via an optional desktop notification and customizable town tune! 🌱


## Features
### Hourly Music 🕒
Listen to the corresponding hourly music from the main Animal Crossing titles:
Expand All @@ -30,7 +29,6 @@ The extension features an awesome Town Tune editor available within the browser.

With it you can compose your custom Town Tune, which will be played every time an hour passes, just like the games!


## Installation

### Chrome Web Store (Stable Version)
Expand All @@ -41,33 +39,19 @@ You can download the source code of the project and install the unpacked extensi

To install the downloaded project, do the following:
1. Unzip the downloaded file
2. Go to the [Chrome Extensions Page](chrome://extensions/), which can be found under `Chrome > Settings > Extensions`
2. Go to the [Chrome Extensions Page](chrome://extensions/), which can be found under `Chrome > Settings > Extensions`
3. Enable the `Developer Mode` switch
4. Click on `Load Unpacked`
5. Choose the unzipped project directory
6. Profit!

### Resources
The `4.0` version of the extension introduces a long-needed change: music is now played remotely! 🎉

The extension no longer contains music files, and the source code does not depend on resources hosted elsewhere.

Thanks to this change, the size of the extension has shrunk from `436MB` to less than `3MB`. That's over a 99% decrease in size!

Downloading the music files and including them into the project directory **is no longer needed** in order to install/use the extension.

You can still find the used music resources in the following link:
- Google Drive: [Animal Crossing Music](https://drive.google.com/open?id=1QjG8QjPt_IKgzZRzmnoH8KTGwTsWSLsR)

### Branch conventions
- The `master` branch contains the latest published version of the extension. This is the stable branch.
- The `develop` branch contains the latest fully-integrated features of the extension. This is where PRs should be merged into.

- The `develop` branch contains the latest fully-integrated features of the extension. This is where PRs should be merged into.

## Help & Support
If you have any questions or doubts, feel free to jump into the project's [Discord Server](https://discord.gg/4FMrEF8).


## Contribute
Contributions to the project are **greatly** appreciated! Here is how you can help to make this project even better:

Expand All @@ -77,14 +61,12 @@ If you want to report a bug, or have a feature request/proposal for improvement,
### PR Submission
[Pull Requests](https://github.com/animal-crossing-music-extension/ac-music-extension/pulls) are equally welcomed. Just make sure to submit them to `develop` and give some love to the PR description!


## Credit
All of the contributors for versions post-3.0 can be found [listed here](https://github.com/animal-crossing-music-extension/Animal-Crossing-Music-Extension/graphs/contributors).

Credit is due to [Andrex](https://www.neogaf.com/members/andrex.20593/) and [blazescorch2](https://www.neogaf.com/members/blazescorch2.142800/) from NeoGAF for developing the original 1.0 and 2.0 versions of the extension.

Original concept of the extension taken from [tane.us](http://tane.us/ac/)


## Licensing
Animal Crossing Music is licensed under the zlib license. See [LICENSE.md](./LICENSE.md) for reference.

0 comments on commit d0ee68c

Please sign in to comment.