Skip to content
This repository was archived by the owner on Aug 11, 2023. It is now read-only.

Commit 6fce75c

Browse files
committed
Update README
1 parent b9208ea commit 6fce75c

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ A simple Python cli that parses your sitemap, sends async requests to the PageSp
66

77
## Why pyspeedinsights?
88

9-
Manually running your website's pages through Lighthouse or PageSpeed Insights can be extremely time consuming and difficult to manage. Especially with a large site.
9+
Manually running your website's pages through Lighthouse or PageSpeed Insights can be extremely time consuming and cumbersome. This is especially true if your site contains a large number of pages.
1010

11-
I personally had a hard time analyzing my site's overal performance from a 10,000-foot view without manually testing many similar types of pages.
11+
There's no easy way to analyze your site's overall performance from a 10,000-foot view without manually testing many similar types of pages.
1212

13-
That's why I made this package. While there are similar tools out there, I couldn't find any solid Python ones that were easy to use.
13+
That's what this package attempts to solve. While there are similar tools out there, there weren't any solid Python ones that were built to support analysis in bulk.
1414

1515
The pyspeedinsights cli allows you to analyze your entire site's performance quickly and uncover bottlenecks by reviewing color-coded audit results and metrics for each page in Excel.
1616

@@ -60,7 +60,9 @@ The API has a daily and per-minute request quota of 25,000 and 240, respectively
6060

6161
This package uses the `keyring` Python library to store API keys securely on your system's default keystore (e.g. MacOS Keychain for MacOS users).
6262

63-
This dependency is installed automatically when you `pip install pyspeedinsights`. If for some reason it's not, run `pip install keyring` before running any `keyring` operations.
63+
*Note: If you're unable to use keyring for whatever reason, a fallback input will prompt you for your API key from the command line at the start of each run.*
64+
65+
The dependency is installed automatically when you `pip install pyspeedinsights`. If for some reason it's not, run `pip install keyring` before running any `keyring` operations.
6466

6567
Please see the [`keyring` documentation](https://github.com/jaraco/keyring#command-line-utility) if you require any additional help with the following commands.
6668

@@ -82,13 +84,13 @@ To remove your API key from your default keystore, run `keyring del system psike
8284

8385
## Sitemap Support
8486

85-
Currently only valid XML sitemaps are supported for reports that use sitemap format.
87+
Currently, only URLs to valid XML sitemaps are supported for reports that utilize sitemap format.
8688

8789
Your web server or sitemap plugin must also allow robots to crawl your sitemap. If you see any permission errors that would be the first thing to check.
8890

8991
In the future, support for sitemap indices, multiple sitemaps and more advanced sitemap parsing will hopefully be added.
9092

91-
Sitemap URLs should be passed in as positional arguments for `url` when running `psi` from the command line.
93+
Your sitemap URL should be passed in as the positional argument for `url` when running `psi` from the command line.
9294

9395
## Command Line Arguments
9496

@@ -242,7 +244,7 @@ Please see the PSI API docs for a [full list of locale options](https://develope
242244

243245
Example:
244246

245-
* `psi https://www.example.com -l ru` - localize results to Russian
247+
* `psi https://www.example.com -l fr` - localize results to French
246248

247249
### UTM Campaign: `-uc` or `--campaign` (optional) (experimental)
248250

0 commit comments

Comments
 (0)