3abn 中文文档教程
$ 3abn
终端中的 3ABN 无线电客户端。
该项目使用来自此页面的媒体流。 您也可以在浏览器中收听。
:cloud: Installation
您可以全局安装该包并将其用作命令行工具:
# Using npm
npm install --global 3abn
# Using yarn
yarn global add 3abn
然后,运行 3abn --help
并查看 CLI 工具可以做什么。
$ 3abn --help
Usage: 3abn [options]
A 3ABN radio client in the terminal.
Options:
-d, --daemon If provided, the process will run in background.
-h, --help Displays this help.
-v, --version Displays version information.
Documentation can be found at https://github.com/IonicaBizau/3abn#readme.
:clipboard: Example
这是一个如何将这个包用作库的示例。 要在本地将其作为库安装,您可以使用 npm install 3abn
(或 yarn add 3abn
):
const ThreeABN = require("3abn")
ThreeABN.playlistInfo((err, data) => {
if (err) { return console.error(err); }
console.log(data.playlist.map(c => `${c.date.format("HH:mm")} - ${c.title}`).join("\n"));
// Start playing
let radio = new ThreeABN({ autoplay: false });
radio.on("song_changed", (err, current, latestFive, playlist) => {
console.log("Playing: " + current);
});
});
:question: Get Help
获得帮助的方法很少:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
有关完整的 API 参考,请参阅DOCUMENTATION.md 文件。
:yum: How to contribute
有想法吗? 发现错误? 查看如何贡献。
:sparkling_heart: Support my projects
我几乎开源了所有我能开源的东西,我试着回复每个需要帮助使用这些项目的人。 明显地, 这需要时间。 您可以免费在您的应用程序中集成和使用这些项目! 您甚至可以更改源代码并重新分发(甚至转售)。
但是,如果您从中获得一些收益,或者只是想鼓励我继续创作,您可以通过几种方式做到这一点:
主演和分享您喜欢的项目 :rocket:
比特币——您可以通过以下地址(或扫描下面的代码)向我发送比特币:
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
谢谢! :heart:
:scroll: License
$ 3abn
A 3ABN radio client in the terminal.
This project uses the media stream from this page. You can listen to it in the browser as well.
:cloud: Installation
You can install the package globally and use it as command line tool:
# Using npm
npm install --global 3abn
# Using yarn
yarn global add 3abn
Then, run 3abn --help
and see what the CLI tool can do.
$ 3abn --help
Usage: 3abn [options]
A 3ABN radio client in the terminal.
Options:
-d, --daemon If provided, the process will run in background.
-h, --help Displays this help.
-v, --version Displays version information.
Documentation can be found at https://github.com/IonicaBizau/3abn#readme.
:clipboard: Example
Here is an example how to use this package as library. To install it locally, as library, you can use npm install 3abn
(or yarn add 3abn
):
const ThreeABN = require("3abn")
ThreeABN.playlistInfo((err, data) => {
if (err) { return console.error(err); }
console.log(data.playlist.map(c => `${c.date.format("HH:mm")} - ${c.title}`).join("\n"));
// Start playing
let radio = new ThreeABN({ autoplay: false });
radio.on("song_changed", (err, current, latestFive, playlist) => {
console.log("Playing: " + current);
});
});
:question: Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
For full API reference, see the DOCUMENTATION.md file.
:yum: How to contribute
Have an idea? Found a bug? See how to contribute.
:sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below):
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! :heart: