Skip to content

Commit c733815

Browse files
authored
Merge pull request #909 from mjbear/modify_readme
Improve grammar/wording in README.md
2 parents 1610560 + e1f24fe commit c733815

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
# Genie Parser
44

55
Genie is both a library framework and a test harness that facilitates rapid
6-
development, encourages re-usability, and simplifies writing test automation. Genie
7-
bundled with the modular architecture of pyATS framework accelerates and
6+
development, encourages re-usability, and simplifies writing test automation.
7+
Genie bundled with the modular architecture of pyATS framework accelerates and
88
simplifies test automation leveraging all the perks of the Python programming
9-
language in an object-orienting fashion.
9+
language in an object-oriented fashion.
1010

1111
pyATS is an end-to-end testing ecosystem, specializing in data-driven and
1212
reusable testing, and engineered to be suitable for Agile, rapid development
@@ -20,11 +20,11 @@ general public starting early 2018 through [Cisco DevNet].
2020
[Cisco DevNet]: https://developer.cisco.com/
2121

2222
This is a sub-component of Genie that parses the device output into structured
23-
datastructure.
23+
data.
2424

2525
# Installation
2626

27-
The package is automatically installed when pyATS gets installed
27+
The Genie package is automatically installed when pyATS gets installed.
2828

2929
```
3030
$ pip install 'pyats[full]'
@@ -62,10 +62,11 @@ Change logs can be found [here](changelog/CHANGELOG.md).
6262

6363
[Guide]
6464

65-
[Guide]: https://pubhub.devnetcloud.com/media/pyats-development-guide/docs/writeparser/writeparser.html#
65+
[Guide]: https://pubhub.devnetcloud.com/media/pyats-development-guide/docs/writeparser/writeparser.html
6666

6767

68-
YouTube Video: <How to write a Genie parser for Cisco!> https://youtube.com/watch?v=ibLNilSfdTc (Thank you! @Jmahaja1)
68+
YouTube Video: <How to write a Genie parser for Cisco!> https://youtube.com/watch?v=ibLNilSfdTc
69+
(Thank you! @Jmahaja1)
6970

7071

7172
Once you create a new parser, don't forget to check 1, 2, and 3;
@@ -75,7 +76,7 @@ if you only update the parser class without modifying/creating the schema, pleas
7576
- [ ] 3. make sure GitHub Actions checks passed.
7677

7778
# How to write a 'changelog' for your contribution:
78-
1. Become familiarized with the examples at [changelog/undistributed/template.rst](https://github.com/CiscoTestAutomation/genieparser/blob/master/changelog/undistributed/template.rst). Changelogs must be written in the same style as the examples found there:
79+
1. Become familiar with the examples at [changelog/undistributed/template.rst](https://github.com/CiscoTestAutomation/genieparser/blob/master/changelog/undistributed/template.rst). Changelogs must be written in the same style as the examples found there:
7980
```
8081
--------------------------------------------------------------------------------
8182
Fix

0 commit comments

Comments
 (0)