Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ken Soh committed Dec 6, 2016
1 parent b1df367 commit cd0eebf
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ TA.Gui is a tool for non-developers and business users to automate web apps
# Why This
Insanely easy. Lightning fast. Open-source.

TA.Gui converts automation flows in simple natural language into lines of JavaScript code for CasperJS & PhantomJS to perform their web automation magic. For example, TA.Gui will instantly convert the flow below into ~100 lines of JavaScript code and perform the series of steps to download a Typeform report automatically. The flow can be triggered from a scheduler, command line, REST API, URL, email etc.
TA.Gui converts automation flows in simple natural language into lines of JavaScript code for CasperJS & PhantomJS to perform their web automation magic. For example, TA.Gui will instantly convert the flow below into ~100 lines of JavaScript code and perform the series of steps to download a Typeform report automatically. Everything happens without seeing any web browser. The flow can be triggered from scheduling, command line, REST API, URL, email etc.

```
https://www.typeform.com
Expand All @@ -25,12 +25,12 @@ download https://admin.typeform.com/form/2592751/analyze/csv|report.csv

# To Use
```
./tagui flow_filename parameters
./tagui flow_filename parameter(s)
```

# Pipeline
Feature|Details
-------|-------
:-----:|:------
Logic Engine|for supporting rule-based decision making
Chrome Extension|facilitates creation of automation flows
Enhancements|configuration, keywords, object repository
Expand All @@ -39,25 +39,27 @@ Passive I/O|xls/csv datatables and web-based reports

# Cheat Sheet
Word|Parameter(s)|Purpose
----|----------|-------
:---|:-----------|:------
tap / click|element to click|click on an element
hover / move|element to hover|move cursor to element
type / enter|element to type|text to type|enter text in element
read / fetch|element to read|variable name|read text into variable
show / print|element to show|print text to screen and logfile
download|url to download|filename to save to|download from url
file|url keyword|filename to save to|download when resource received
echo|none|print text and variables to screen and logfile
save|element to save|optional filename to save to|save element text to file
type / enter|element to type in|text to type|enter text in element
read / fetch|element to read from|variable name|fetch text into variable
show / print|element to read from|print text to screen and logfile
download|url to download|filename to save to|download file from url
file|url keyword to watch for|filename to save to|download when resource received
echo|text and variables (text in quotes)|print text/variables to screen and logfile
save|element to read from|optional filename to save to|save element text to file
dump|variable name|optional filename to save to|save variable to file
snap|element to snapshot (page for whole screen)|optional filename to save to|save screenshot to file
snap|element (page for whole screen)|optional filename to save to|save screenshot to file
wait|time in milliseconds|wait for some time
test|condition to test|text if true|text if false|test a condition and print result to screen and logfile
frame|frame name|subframe name if any|specify that next step is within a HTML frame/subframe
frame|frame name|subframe name if any|specify that next step is within frame/subframe

1. Above words are case-insensitive to let users write flexibly in the way they want
2. Extra spaces between parameters are automatically trimmed; don't worry about them
3. JavaScript can be used and executed within CasperJS's context, if/for/while applies to next step
3. JavaScript can be used (in CasperJS's context); if/for/while applies to next step
4. XPath is most robust and used to check for a particular element on the webpage
5. XPath checked in following priority xpath, id, name, class, title, text()

# License
TA.Gui is open-source software released under the MIT license

0 comments on commit cd0eebf

Please sign in to comment.