Skip to content

small edits #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Norbgorb wants to merge 1 commit into
base: master
Choose a base branch
from
Open

small edits #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Chromatic

🍪 Configurable human assisted Chrome automation
🍪 Chromatic is a tool for Configurable human assisted Chrome automation.
Copy link
Owner

@joshdk joshdk Jul 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The capitalization needs to be fixed, and it doesn't read quite right. How about:

🍪 A tool for configurable, human-assisted Chrome automation

Having "Chromatic" at the start of the line and as the header above, stutters a little.


## Installing

Expand All @@ -20,7 +20,7 @@ $ go get -u github.com/joshdk/chromatic

There are certain services that require programmatic interaction, but otherwise make it difficult. Web-only APIs, [CAPTCHAs](https://en.wikipedia.org/wiki/CAPTCHA), and MFA are a few examples of things that might not work well with typical automation.

This tool, `chromatic`, implements an escape-hatch around these difficulties. It can be configured to open up a Chrome window to a given starting URL, and will continue to be interactive until a given set of ending conditions are met, at which time the Chrome window will close. This user interaction is typically a login flow.
`Chromatic` implements an escape-hatch around these difficulties. It can be configured to open up a Chrome window to a given starting URL, and will continue to be interactive until a given set of ending conditions are met, at which time the Chrome window will close. This user interaction is typically a login flow.
Copy link
Owner

@joshdk joshdk Jul 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this. Small nitpick would be to just have the word "Chromatic" in non-code style. Use chromatic when referring to command line literals.


When `chromatic` exits, it will dump details about the last visited page as json. This json (and the session data contained within) is meant to be consumed by additional automation.

Expand Down