Permalink
Browse files

Internal: Update README

- Include COC
- Include Contribution guidelines
- Create Issue-Template
  • Loading branch information...
pichfl committed Jun 18, 2018
1 parent 0d800ef commit a6da3f90cdda09531136833c754f4995d27bdd20
Showing with 129 additions and 16 deletions.
  1. +9 −0 .github/ISSUE_TEMPLATE.md
  2. +50 −0 CODE_OF_CONDUCT.md
  3. +30 −0 CONTRIBUTING.md
  4. +40 −16 README.md
@@ -0,0 +1,9 @@
* Do you want to request a *feature* or report a *bug*?
* What is the current behavior?
* If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo / screenshot / screen recording of the problem.
* What is the expected behavior?
* What is the motivation / use case for changing the behavior?
* Please tell us about your environment:
* Version of BookPlayer
* Your Device and its OS version
* Other information
@@ -0,0 +1,50 @@
# Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <help@bookplayer.app> All
complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
@@ -0,0 +1,30 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.

Please see [our Roadmap](https://github.com/GianniCarlo/Audiobook-Player/projects/1) if your request is already in consideration. Also check [pull requests](https://github.com/GianniCarlo/Audiobook-Player/pulls?utf8=✓&q=is%3Apr) for previous efforts. If in doubt, open a new issue. Don't be shy, but understand that we might close issues to focus the discussion and development.

Please note we have a code of conduct, please follow it in all your interactions with the project.

## Reporting a bug

1. Check [previous issues](https://github.com/GianniCarlo/Audiobook-Player/issues?utf8=✓&q=is%3Aissue). Your bug may be already fixed in the next version waiting to be released.
2. Describe your issue as extensive as possible. Our issue template will provide some basics.
3. BookPlayer shows its version number and other debug info at the very end of the settings screen.

## Pull Request Process

1. Make sure the code you present is properly documented and tested.
2. Try to be as concise as possible. This makes it eaier to discuss and evaluate the changes you propose.
3. Be patient. Open Source takes time.
4. Be attentive. Pull requests are base for discussion and will require your feedback.
5. Pull requests without futher interaction may be closed at any point.

While your contribution will be under [the license of the project](./LICENSE) (GNU GPL v. 3.0), be aware that it will most likely end up being part of a compiled binary available in the Apple App Store.



# Code of Conduct

Be excellent to each other. See [our Code of Conduct](./CODE_OF_CONDUCT.md) for details.
@@ -1,5 +1,6 @@
<img src="./.github/readme-header.png" alt="BookPlayer" width="888" height="300">
<p align="center">Audiobook player made in Swift for your DRM-free audiobooks.</p>
![BookPlayer](./.github/readme-header.png)

<p align="center">A wonderful player for your DRM-free audiobooks made in Swift and your help.</p>
<p align="center">
<a href="https://itunes.apple.com/us/app/bookplayer-audio-book-player/id1138219998?ls=1&amp;mt=8">
<img src="./.github/app-store-badge.svg" alt="Download on the App Store">
@@ -10,42 +11,63 @@
<img src="./.github/player_screenshot.png" width="350" />
</p>



## Features

- Upload your DRM-free audiobooks to your device via file sharing in iTunes
- Load books from other apps on your device (e.g. Dropbox)
- Import books via AirDrop
### Import

- Using [AirDrop](https://support.apple.com/en-us/HT204144#receive)
- From [Files](https://support.apple.com/en-us/ht206481) and other apps on your device
- Via [File Sharing](https://support.apple.com/en-us/HT201301) in iTunes

### Manage

- Maintain and see progress of your books
- Mark books as finished
- Drag & Drop to sort your library
- Create playlists
- Automatically play items in turn
- Play the first unfinished file by tapping on the playlist artwork
- Move files to playlists from the library or import them directly

### Listen

- Control audio playback from the lock screen or the control center
- Maintain progress of your audiobooks
- Supports books with Chapters
- Delete uploaded books from the app
- Play and navigate books with Chapters
- Jump to start of the current book
- Mark book as finished
- Change playback speed
- Smart rewind
- Boost volume
- Support for remote events from headset buttons
- Automatically plays next item in list
- Smart rewind: Automatically go back when the player was paused for a bit longer
- Volume Boost: Doubles the volume
- Support for remote events from headset buttons and the lock screen
- Sleep timer with adjustable duration

### Upcoming features

See [our Roadmap on GitHub](https://github.com/GianniCarlo/Audiobook-Player/projects/1) for details



## Contributing

Pull requests regarding upcoming features and bugfixes are always welcomed. Please [open an issue](https://github.com/GianniCarlo/Audiobook-Player/issues/new) if you have any suggestions or found a bug. 👍
Pull requests and ideas are always welcomed. Please [open an issue](https://github.com/GianniCarlo/Audiobook-Player/issues/new) if you have any suggestions or found a bug. 👍 See our [Contribution Guidelines](./CONTRIBUTING.md) for details.

### Maintainers

- [@GianniCarlo](https://github.com/GianniCarlo) - Original Idea & Creation
- [@pichfl](https://github.com/pichfl) - UI Design & Artwork

### Contributors

- [@GianniCarlo](https://github.com/GianniCarlo) - Creator
- [@bryanrezende](https://github.com/bryanrezende) - Smart rewind
- [@e7mac](https://github.com/e7mac) - Speed control, Autoplay
- [@gpambrozio](https://github.com/gpambrozio) - Volume Boost
- [@pichfl](https://github.com/pichfl) - UI Design, Artwork, Refactoring
- [@vab9](https://github.com/vab9) - AirDrop Support

A full list of all contributors can be found [on GitHub.](https://github.com/GianniCarlo/Audiobook-Player/graphs/contributors)



## Dependencies

Managed with [Carthage](https://github.com/Carthage/Carthage)
@@ -60,6 +82,8 @@ Managed with [Homebrew](https://brew.sh)

- [SwiftLint](https://github.com/realm/SwiftLint)



## License

Licensed under [GNU GPL v. 3.0](https://opensource.org/licenses/GPL-3.0). See `LICENSE` for details.

0 comments on commit a6da3f9

Please sign in to comment.