README.md in xml_tree_viewer-0.1.1 vs README.md in xml_tree_viewer-0.1.2
- old
+ new
@@ -1,24 +1,25 @@
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/Headline.svg" height="55px" name="XML Tree Viewer" alt="# Xml Tree Viewer">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/Headline.svg" height="45px" name="headline" alt="# Xml Tree Viewer">
</a>
A .xml string will do up to a easy readable tree strcuture for terminal output.
<br>
-<br>
+
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/examples.svg" height="55px" name="examples" alt="Examples">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/examples.svg" height="38px" name="examples" alt="Examples">
</a>
### Detail
**Code**
```ruby
- require 'xml_tree_viewer'
- xml = XmlTreeViewer.helper()
- XmlTreeViewer.generate( xml, :detail )
+require 'xml_tree_viewer'
+
+xml = XmlTreeViewer.helper()
+XmlTreeViewer.generate( xml, :detail )
```
**Output**
```txt
TREE OVERVIEW
employees
@@ -35,13 +36,14 @@
### Short
**Code**
```ruby
- require 'xml_tree_viewer'
- xml = XmlTreeViewer.helper()
- XmlTreeViewer.generate( xml, :short )
+require 'xml_tree_viewer'
+
+xml = XmlTreeViewer.helper()
+XmlTreeViewer.generate( xml, :short )
```
**Output**
```txt
TREE OVERVIEW
@@ -51,41 +53,44 @@
┗━ employee
┗━ fullname
```
<br>
<br>
-<br>
-<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/table-of-contents.svg" height="55px" name="table-of-contents" alt="Table of Contents">
+<a href="#headline">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/table-of-contents.svg" height="38px" name="table-of-contents" alt="Table of Contents">
</a>
+
<br>
+1. [Examples](#examples)<br>
1. [Quickstart](#quickstart)<br>
-2. [Parameters](#parameters)<br>
-3. [Contributing](#contributing)<br>
-4. [Limitations](#limitations)<br>
-5. [Credits](#credits)<br>
-6. [License](#license)<br>
-7. [Code of Conduct](#code-of-conduct)<br>
-8. [Support my Work](#support-my-work)<br>
+2. [Setup](#setup)<br>
+3. [Methods](#methods)<br>
+4. [Contributing](#contributing)<br>
+5. [Limitations](#limitations)<br>
+6. [Credits](#credits)<br>
+7. [License](#license)<br>
+8. [Code of Conduct](#code-of-conduct)<br>
+9. [Support my Work](#support-my-work)<br>
<br>
-<br>
+
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/quickstart.svg" height="55px" name="quickstart" alt="Quickstart">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/quickstart.svg" height="38px" name="quickstart" alt="Quickstart">
</a>
```ruby
require '../lib/xml_tree_viewer'
xml = XmlTreeViewer.helper()
XmlTreeViewer.generate( xml, :detail )
```
+
<br>
-<br>
+
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/setup.svg" height="55px" name="setup" alt="Setup">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/local-path-builder-for-ruby/readme/headlines/setup.svg" height="38px" name="setup" alt="Setup">
</a>
Add this line to your application's Gemfile:
```ruby
@@ -104,26 +109,28 @@
On Rubygems:
- Gem: https://rubygems.org/gems/xml_tree_viewer
- Profile: https://rubygems.org/profiles/a6b8
<br>
-<br>
+
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/methods.svg" height="55px" name="methods" alt="Methods">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/methods.svg" height="38px" name="methods" alt="Methods">
</a>
### .helper()
+Output a sample xml string
```ruby
- xml = XmlTreeViewer.helper()
+xml = XmlTreeViewer.helper()
```
### .generate()
+Generate xml tree from string input
```ruby
- XmlTreeViewer.generate(
- xml,
- mode
- )
+XmlTreeViewer.generate(
+ xml,
+ mode
+)
```
**Input**
| **Type** | **Required** | **Description** | **Example** | **Description** |
@@ -133,56 +140,54 @@
**Return**<br>
Boolean
<br>
-<br>
+
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/contributing.svg" height="55px" name="contributing" alt="Contributing">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/contributing.svg" height="38px" name="contributing" alt="Contributing">
</a>
Bug reports and pull requests are welcome on GitHub at https://github.com/a6b8/xml-tree-viewer-for-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/a6b8/xml-tree-viewer-for-ruby/blob/master/CODE_OF_CONDUCT.md).
+
<br>
-<br>
-<br>
+
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/limitations.svg" height="55px" name="limitations" alt="Limitations">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/limitations.svg" height="38px" name="limitations" alt="Limitations">
</a>
+
- Tested for Rss and Atom Feeds.
+
<br>
-<br>
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/credits.svg" height="55px" name="credits" alt="Credits">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/credits.svg" height="38px" name="credits" alt="Credits">
</a>
This gem depend on following gems:
-- nokogiri<br>
-https://rubygems.org/gems/nokogiri
+- [nokogiri](https://rubygems.org/gems/nokogiri)<br>
+- [active_support](https://rubygems.org/gems/activesupport)<br>
-- active_support<br>
-https://rubygems.org/gems/activesupport
-
<br>
-<br>
+
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/license.svg" height="55px" name="license" alt="License">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/license.svg" height="38px" name="license" alt="License">
</a>
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
<br>
-<br>
-<br>
+
<a href="#table-of-contents">
-<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/code-of-conduct.svg" height="55px" name="code-of-conduct" alt="Code of Conduct">
+<img src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/code-of-conduct.svg" height="38px" name="code-of-conduct" alt="Code of Conduct">
</a>
Everyone interacting in the xml-tree-viewer-for-ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/a6b8/xml-tree-viewer-for-ruby/blob/master/CODE_OF_CONDUCT.md).
+
<br>
-<br>
-<br>
+
<a href="#table-of-contents">
-<img href="#table-of-contents" src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/support-my-work.svg" height="55px" name="support-my-work" alt="Support my Work">
+<img href="#table-of-contents" src="https://raw.githubusercontent.com/a6b8/a6b8/main/docs/xml-tree-viewer-for-ruby/readme/headlines/support-my-work.svg" height="38px" name="support-my-work" alt="Support my Work">
</a>
Donate by [https://www.paypal.com](https://www.paypal.com/donate?hosted_button_id=XKYLQ9FBGC4RG)
\ No newline at end of file