removing v1 links and general updates

CFBD · Feb 16, 2025 · cbd51aa · cbd51aa
1 parent 2723360
commit cbd51aa
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 38 deletions.
diff --git a/pages/about.vue b/pages/about.vue
@@ -38,11 +38,12 @@
       <p>This website and its companion API are completely free to use without restrictions.
         Attribution
         is always greatly appreciated. Some functionality may be available exclusively to Patreon subscribers. Patreon
-        subscribers also are able to use the API with less frequent request throttling.</p>
-      <p>Please utilize good API usage habits when interacting with the API. This includes making
-        efficient use of calls to grab greater chunks of data at a time as opposed to more frequent calls of smaller data
-        chunks (i.e. "chunky" vs "chatty" calls). Abusing the free and public nature of the API may result in your key
-        becoming blacklisted.</p>
+        subscribers are alotted a greater number of monthly calls based on tier.</p>
+      <p>In order to make efficient use of your monthly calls, it is recommended to prefer "chunky" requests over "chatty" requests.
+        For example, if an endpoint only requires a "year" filter and you need data for every single team or every single game, it is better to make
+        a single request specifying only the "year" parameter and returning all needed data in a single call rather than making a request for each team (130+ requests) or game (800+ requests).
+        Similarly, if an endpoint requires a "week" parameter, you can grab an entire season's worth of data for all teams in ~15 calls (one for each week) contrasted with 130+ calls required to loop team-by-team.
+      </p>
       <Divider></Divider>
       <div class="text-lg font-bold text-center">Data Corrections and New Data</div>
       <p>If you have data corrections or even some new data you would like to submit for inclusion,

diff --git a/pages/index.vue b/pages/index.vue
@@ -21,6 +21,28 @@
         CFBD API V1 will be sunset in Spring 2025.
         <a href="https://blog.collegefootballdata.com/api-v2-is-now-in-general-availability/">Click here for more details.</a>
       </Message>
+      <Card class="mb-4">
+          <template #title>Welcome to CollegeFootballData.com!</template>
+          <template #content>
+              <p class="m-0">
+                  CollegeFootballData.com is your source for college football data and analytics. Click the 'Data' tab to query and export data to CSV format.
+                  The best way to access data is via the public API in the programming language of your choice. Official packages are available for Python and TypeScript.
+                  A GraphQL API with live data subscriptions is also avaialable to Patreon Tier 3 subscribers.
+                  API keys are required for all requests and can be used for both the Football and Basketball APIs. <NuxtLink to="/key">Get your API key here!</NuxtLink>
+              </p>
+              <p class="m-0 mt-2">
+                This is a public API that comes from very humble beginnings, but is only made possible due the the support of Patreon subscribers.
+                As such, monthly requests are alotted by Patreon level. Patreon registration is NOT required for the free tier. Monthly call limits are as follows:
+                <ul>
+                  <li>Free Tier: 500 monthly calls</li>
+                  <li>Tier 1 ($1/mo): 5000 monthly calls</li>
+                  <li>Tier 2 ($5/mo): 30,000 monthly calls</li>
+                  <li>Tier 3 ($10/mo): 75,000 monthly calls (+ unlimited GraphQL requests)</li>
+                </ul>
+                If you need more than 75,000 monthly calls, please contact me directly.
+              </p>
+          </template>
+      </Card>
       <BlogGroup />
     </main>
     <div class="col-12 md:col-3 text-center">

diff --git a/stores/navigation.ts b/stores/navigation.ts
@@ -63,39 +63,6 @@ export const useNavigationStore = defineStore("navigation", () => {
       },
       {
         label: "API",
-        items: [
-          {
-            label: "Docs",
-            url: "https://api.collegefootballdata.com",
-            target: "_blank"
-          },
-          {
-            label: "API Keys",
-            route: "/key"
-          },
-          {
-            separator: true,
-            label: "Wrappers",
-          },
-          {
-            label: "Python",
-            url: "https://pypi.org/project/cfbd/",
-            target: "_blank"
-          },
-          {
-            label: "JavaScript",
-            url: "https://www.npmjs.com/package/cfb.js",
-            target: "_blank"
-          },
-          {
-            label: "C#",
-            url: "https://www.nuget.org/packages/CFBSharp/",
-            target: "_blank"
-          },
-        ],
-      },
-      {
-        label: "API v2",
         items: [
           {
             label: "Docs",