Skip to content

Commit

Permalink
doc: freshen up README "getting help" section
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
flavorjones committed Jan 23, 2021
1 parent c42ad7f commit aa626cc
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Expand Up @@ -36,29 +36,39 @@ Some guiding principles Nokogiri tries to follow:
[![Tidelift dependencies](https://tidelift.com/badges/package/rubygems/nokogiri)](https://tidelift.com/subscription/pkg/rubygems-nokogiri?utm_source=rubygems-nokogiri&utm_medium=referral&utm_campaign=readme)


## Support and Help
## Support, Getting Help, and Reporting Issues

All official documentation is posted at https://nokogiri.org (the source for which is at https://github.com/sparklemotion/nokogiri.org/, and we welcome contributions).

Consider subscribing to [Tidelift][tidelift] which provides license assurances and timely security notifications for your open source dependencies, including Nokogiri. [Tidelift][tidelift] subscriptions also help the Nokogiri maintainers fund our [automated testing](https://ci.nokogiri.org) which in turn allows us to ship releases, bugfixes, and security updates more often.

[tidelift]: https://tidelift.com/subscription/pkg/rubygems-nokogiri?utm_source=rubygems-nokogiri&utm_medium=referral&utm_campaign=readme

### Reading

Your first stops for API documentation should be:
Your first stops for learning more about Nokogiri should be:

- RDocs: https://nokogiri.org/rdoc/index.html
- [API Documentation](https://nokogiri.org/rdoc/index.html)
- [Tutorials](https://nokogiri.org/tutorials/toc.html)
- An excellent community-maintained [Cheat Sheet](https://github.com/sparklemotion/nokogiri/wiki/Cheat-sheet)


### Questions
### Ask For Help

If you'd like to talk to a human:
There are a few ways to ask exploratory questions:

- The Discord chat channel is `#nokogiri-💎` at https://discord.gg/UyQnKrT
- The Nokogiri mailing list is active at https://groups.google.com/group/nokogiri-talk
- The Nokogiri bug tracker is at https://github.com/sparklemotion/nokogiri/issues
- Open an issue using the "Help Request" template at https://github.com/sparklemotion/nokogiri/issues

Consider subscribing to [Tidelift][tidelift] which provides license assurances and timely security notifications for your open source dependencies, including Nokogiri. [Tidelift][tidelift] subscriptions also help the Nokogiri maintainers fund our [automated testing](https://ci.nokogiri.org) which in turn allows us to ship releases, bugfixes, and security updates more often.
Please do not mail the maintainers at their personal addresses.

[tidelift]: https://tidelift.com/subscription/pkg/rubygems-nokogiri?utm_source=rubygems-nokogiri&utm_medium=referral&utm_campaign=readme

### Report A Bug

The Nokogiri bug tracker is at https://github.com/sparklemotion/nokogiri/issues

Please use the "Bug Report" or "Installation Difficulties" templates.


### Security and Vulnerability Reporting
Expand Down

0 comments on commit aa626cc

Please sign in to comment.