Skip to content

Commit

Permalink
Updating badges to show both develop and master
Browse files Browse the repository at this point in the history
  • Loading branch information
pixelastic committed Feb 15, 2018
1 parent 62bc3c6 commit 04dda60
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# algolia_html_extractor

[![Gem Version][1]](http://badge.fury.io/rb/algolia_html_extractor)
[![Build Status][2]](https://travis-ci.org/algolia/html-extractor)
[![Coverage Status][3]](https://coveralls.io/github/algolia/html-extractor?branch=master)
[![Code Climate][4]](https://codeclimate.com/github/algolia/html-extractor)
![Ruby >= 2.3.0][5]
[![gem version][1]](https://rubygems.org/gems/algolia_html_extractor)
![ruby][2]
[![build master][3]](https://travis-ci.org/algolia/html-extractor)
[![coverage master][4]](https://coveralls.io/github/algolia/html-extractor?branch=master)
[![build develop][5]](https://travis-ci.org/algolia/html-extractor)
[![coverage develop][6]](https://coveralls.io/github/algolia/html-extractor?branch=develop)

This gem can convert HTML content into JSON records ready to be pushed to
Algolia.
Expand Down Expand Up @@ -99,13 +100,13 @@ Each record has a `objectID` that uniquely identify it (computed by a hash of al
the other values).

It also contains the HTML tag name in `tag_name` (by default `<p>`
paragraphs are extracted, but see the [settings][6] on how to change it).
paragraphs are extracted, but see the [settings][7] on how to change it).

`html` contains the whole `outerContent` of the element, including the wrapping
tags and inner children. The `text` attribute contains the textual content,
stripping out all HTML.

`node` contains the [Nokogiri node][7] instance. The lib uses it internally to
`node` contains the [Nokogiri node][8] instance. The lib uses it internally to
extract all the relevant information but is also exposed if you want to process
the node further.

Expand All @@ -115,7 +116,7 @@ Anchors are searched in `name` and `id` attributes of headings.

`hierarchy` then contains a snapshot of the current heading hierarchy of the
paragraph. The `lvlX` syntax is used to be compatible with the records
[DocSearch][8] is using.
[DocSearch][9] is using.

The `weight` attribute is used to provide an easy way to rank two records
relative to each other.
Expand Down Expand Up @@ -148,7 +149,7 @@ and generic bug reports.
## Bug Reports and feature requests

For any bug or ideas of new features, please start by checking in the
[issues][9] tab if
[issues][10] tab if
it hasn't been discussed already. If not, feel free to open a new issue.

## Pull Requests
Expand Down Expand Up @@ -217,11 +218,12 @@ convention. That's also why this gem directly starts at v2.0.


[1]: https://badge.fury.io/rb/algolia_html_extractor.svg
[2]: https://travis-ci.org/algolia/html-extractor.svg?branch=master
[3]: https://coveralls.io/repos/algolia/html-extractor/badge.svg?branch=master&service=github
[4]: https://codeclimate.com/github/algolia/html-extractor/badges/gpa.svg
[5]: https://img.shields.io/badge/ruby-%3E%3D%202.3.0-green.svg
[6]: #Settings
[7]: http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node
[8]: https://community.algolia.com/docsearch/
[9]: https://github.com/pixelastic/html-hierarchy-extractor/issues
[2]: https://img.shields.io/badge/ruby-%3E%3D%202.3.0-green.svg
[3]: https://img.shields.io/badge/dynamic/json.svg?label=build%3Amaster&query=value&uri=https%3A%2F%2Fimg.shields.io%2Ftravis%2Falgolia%2Fhtml-extractor.json%3Fbranch%3Dmaster
[4]: https://img.shields.io/badge/dynamic/json.svg?label=coverage%3Amaster&colorB=&prefix=&suffix=%25&query=$.covered_percent&uri=https%3A%2F%2Fcoveralls.io%2Fgithub%2Falgolia%2Fhtml-extractor.json%3Fbranch%3Dmaster
[5]: https://img.shields.io/badge/dynamic/json.svg?label=build%3Adevelop&query=value&uri=https%3A%2F%2Fimg.shields.io%2Ftravis%2Falgolia%2Fhtml-extractor.json%3Fbranch%3Ddevelop
[6]: https://img.shields.io/badge/dynamic/json.svg?label=coverage%3Adevelop&colorB=&prefix=&suffix=%25&query=$.covered_percent&uri=https%3A%2F%2Fcoveralls.io%2Fgithub%2Falgolia%2Fhtml-extractor.json%3Fbranch%3Ddevelop
[7]: #Settings
[8]: http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node
[9]: https://community.algolia.com/docsearch/
[10]: https://github.com/pixelastic/html-hierarchy-extractor/issues

0 comments on commit 04dda60

Please sign in to comment.