Skip to content

Commit 25699ed

Browse files
Merge pull request #721 from Abhijay007/Abhijay007/status-badges
(Docs): Improved docs and updated info for repo visitors
2 parents 1b4e0c4 + fec4dcd commit 25699ed

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,47 @@
1-
[![Build Status](https://travis-ci.com/processing/p5.js-sound.svg?branch=master)](https://travis-ci.com/processing/p5.js-sound)
1+
[![Build Status](https://travis-ci.com/processing/p5.js-sound.svg?branch=master)](https://travis-ci.com/processing/p5.js-sound)
2+
[![GitHub contributors](https://img.shields.io/github/contributors/processing/p5.js-sound)](https://github.com/processing/p5.js-sound/graphs/contributors)
3+
[![GitHub issues](https://img.shields.io/github/issues-raw/processing/p5.js-sound)](https://github.com/processing/p5.js-sound/issues)
4+
[![Twitter Follow](https://img.shields.io/twitter/follow/p5xjs?style=social)](https://twitter.com/p5xjs)
5+
[![GitHub forks](https://img.shields.io/github/forks/processing/p5.js-sound?style=social)](https://github.com/processing/p5.js-sound/fork)
6+
![GitHub Repo stars](https://img.shields.io/github/stars/processing/p5.js-sound?style=social)
7+
[![GitHub Sponsors](https://img.shields.io/github/sponsors/processing)](https://github.com/sponsors/processing)
28

39
![](https://cloud.githubusercontent.com/assets/504124/19908328/2cd874ea-a059-11e6-847c-e5da5e957a2f.jpg)
410

5-
p5.sound
6-
========
11+
# p5.sound
12+
713
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/processing/p5.js-sound?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
14+
[![Discord](https://img.shields.io/discord/836700474425475088?logo=discord)](https://discord.gg/HWzy4HpaEJ)
815

916
p5.sound brings the [Processing](http://processing.org) approach to [Web Audio](http://w3.org/TR/webaudio/) as an addon for [p5.js](http://github.com/lmccart/p5.js). Functionality includes audio input, playback, manipulation, effects, recording, sequencing, analysis and synthesis. The library is designed to be used in tandem with [p5.js](http://p5js.org).
1017

1118
### Examples
12-
* Examples at [p5js.org/examples](https://p5js.org/examples/)
13-
* Additional examples at [processing.github.io/p5.js-sound](https://processing.github.io/p5.js-sound/)
14-
* p5.js Sound Tutorial by Dan Shiffman on [YouTube](https://www.youtube.com/playlist?list=PLRqwX-V7Uu6aFcVjlDAkkGIixw70s7jpW)
1519

16-
### [Documentation](http://p5js.org/reference/#/libraries/p5.sound)
17-
Interactive documentation at [p5js.org/reference/#/libraries/p5.sound](http://p5js.org/reference/#/libraries/p5.sound)
20+
- Examples at [p5js.org/examples](https://p5js.org/examples/)
21+
- Additional examples at [processing.github.io/p5.js-sound](https://processing.github.io/p5.js-sound/)
22+
- p5.js Sound Tutorial by Dan Shiffman on [YouTube](https://www.youtube.com/playlist?list=PLRqwX-V7Uu6aFcVjlDAkkGIixw70s7jpW)
1823

24+
### [Documentation](http://p5js.org/reference/#/libraries/p5.sound)
1925

26+
Interactive documentation at [p5js.org/reference/#/libraries/p5.sound](http://p5js.org/reference/#/libraries/p5.sound)
2027

2128
### Latest Build
22-
* Visit http://p5js.org/download/ for the latest official release of p5 with the latest p5.sound included.
23-
* The sound library [here](https://github.com/processing/p5.js-sound/blob/master/lib) is updated more frequently, and we occasionally offer new [releases](https://github.com/processing/p5.js-sound/releases) before p5's release cycle.
2429

30+
- Visit http://p5js.org/download/ for the latest official release of p5 with the latest p5.sound included.
31+
- The sound library [here](https://github.com/processing/p5.js-sound/blob/master/lib) is updated more frequently, and we occasionally offer new [releases](https://github.com/processing/p5.js-sound/releases) before p5's release cycle.
2532

2633
### Contribute
34+
2735
[Here's a guide](https://github.com/processing/p5.js-sound/wiki/Contribute) to getting started as a contributor.
2836

37+
Note : If you have any questions or concerns regarding the project, you can reach out to our [Discord](https://discord.gg/HWzy4HpaEJ) and [Gitter](https://gitter.im/processing/p5.js-sound) communities. The p5.js team closely monitors all pull requests and issues on GitHub, so there's no need to also post them on Discord. Additionally, conversations about specific pull requests and issues should take place on GitHub, to ensure that people following along over can see and take part in the whole discussion. Thanks - p5.js Team.
2938

3039
### Dependencies
40+
3141
p5.sound is built with a few modules (Clock, TimelineSignal, and signal math components) from [Tone.js](https://github.com/tonejs/Tone.js), an interactive music framework developed by Yotam Mann.
3242

3343
### References and Inspiration
44+
3445
- [Yotam Mann & TONE.js](https://github.com/tonejs/Tone.js)
3546
- [Boris Smus Web Audio API book](http://smus.com/webaudio-book/)
3647
- [wavesurfer.js](https://github.com/katspaugh/wavesurfer.js)

0 commit comments

Comments
 (0)