Merge pull request #29 from erin2722/docs-updates

small docs upgrades

README.md

@@ -30,12 +30,12 @@ from usau_scraper import *
 
 # Get a team's basic information
 print(getTeamInfo(
-    schoolName = 'Columbia', 
-    teamName = 'Baewatch', 
-    genderDivision='Women', 
-    state='NY', 
-    competitionLevel='College', 
-    competitionDivision='Division 1', 
+    schoolName = 'Columbia',
+    teamName = 'Baewatch',
+    genderDivision='Women',
+    state='NY',
+    competitionLevel='College',
+    competitionDivision='Division 1',
     teamDesignation='B'))
 
 # Get a team's schedule for the current season
@@ -47,11 +47,17 @@ print(getTeamRoster(schoolName='Columbia', teamName='Curbside'))
 # Get the pool play results for a tournament
 print(getTournamentPoolPlayResults("College", "Women", eventName="No Sleep Till Brooklyn", season=2023))
 
-# Get the bracekt results for a tournament
+# Get the bracket results for a tournament
 print(getTournamentBracketResults("College", "Women", eventName="Centex", season=2022))
 
 # Get the winner for a tournament
 print(getTournamentWinner("College", "Women", eventName="Stanford Invite", season=2023))
+
+# Get the top 20 women's college teams
+print(getCollegeRankings(genderDivision="Women"))
+
+# Get the top 20 women's club teams
+print(getClubRankings(genderDivision="Women"))
 ```
 
 Additional usage examples are [in this notebook](https://colab.research.google.com/github/erin2722/usau-scraper/blob/main/examples/usau_scraper_example.ipynb#scrollTo=20Fjgtxr35ES).
@@ -65,7 +71,7 @@ Additional usage examples are [in this notebook](https://colab.research.google.c
 
 ## Additional features
 
-- [ ] A function that, given a college division, returns the current standings of that division.
+- [x] A function that, given a college division, returns the current standings of that division.
 - [ ] An additional plugin to ultiworld to show recent articles given a team name or college division.
 - [ ] More features tbd!
 

docs/source/index.rst

@@ -20,14 +20,11 @@ usau-scraper documentation
 
 Installation
 ===================================
-:code:`pip install usau-scraper`
+:code:`pip install --upgrade usau-scraper`
 
 How to Use
 ===================================
-After installing the library, there are currently 3 functions available for use:
-``getTeamInfo``, ``getTeamSchedule``, and ``getTeamRoster``.
-
-Simply :code:`import * from usau_scraper`, and get started!
+Simply :code:`from usau_scraper import *`, and get started!
 
 More extensive module documentation is here:
 :ref:`modules`
@@ -38,7 +35,7 @@ After :code:`pip install --upgrade usau-scraper` in your python env:
 
 ::
 
-   from usau_scraper import getTeamInfo, getTeamSchedule, getTeamRoster
+   from usau_scraper import *
 
    # Get a team's basic information
    print(getTeamInfo(
@@ -56,6 +53,21 @@ After :code:`pip install --upgrade usau-scraper` in your python env:
    # Get a team's roster for the current season
    print(getTeamRoster(schoolName='Columbia', teamName='Curbside'))
 
+   # Get the pool play results for a tournament
+   print(getTournamentPoolPlayResults("College", "Women", eventName="No Sleep Till Brooklyn", season=2023))
+
+   # Get the bracket results for a tournament
+   print(getTournamentBracketResults("College", "Women", eventName="Centex", season=2022))
+
+   # Get the winner for a tournament
+   print(getTournamentWinner("College", "Women", eventName="Stanford Invite", season=2023))
+
+   # Get the top 20 women's college teams
+   print(getCollegeRankings(genderDivision="Women"))
+
+   # Get the top 20 women's club teams
+   print(getClubRankings(genderDivision="Women"))
+
 Additional usage examples are `in this notebook <https://colab.research.google.com/github/erin2722/usau-scraper/blob/main/examples/usau_scraper_example.ipynb#scrollTo=rEfGbe_ruqk4>`_.
 
 Indices and tables