[Issue #31] Update repo with working title (#47)

* refactor: Updates TypeSpec library to use CommonGrants
* refactor: Updates custom API example to use CommonGrants
* docs: Updates and expands READMEs

README.md

@@ -1,6 +1,6 @@
-# Simpler grant protocol
+# CommonGrants protocol
 
-A common standard for sharing data about grant opportunities, applications, and awards.
+An open standard for sharing data about funding opportunities, applications, and awards across the grants ecosystem.
 
 ## Key resources
 
@@ -9,3 +9,5 @@ A common standard for sharing data about grant opportunities, applications, and
 
 - [Protocol website](https://hhs.github.io/simpler-grants-protocol/)
 - [`website/` codebase](website): The code for our public website and docs.
+- [Specification](specs): TypeSpec library for the CommonGrants specification.
+- [Examples](examples): Example projects that adopt or extend the CommonGrants protocol.

examples/README.md

@@ -0,0 +1,7 @@
+# CommonGrants examples
+
+A directory of sample projects that demonstrate how to implement and extend the CommonGrants protocol.
+
+## Example projects
+
+- [Custom API](custom-api): Demonstrates a simple example of an API spec that extends the base CommonGrants protocol.

examples/custom-api/README.md

@@ -55,11 +55,11 @@ Run the following steps from the root of this directory to install the custom AP
 You can define custom field by using `extends CustomField {}` where `CustomField` is a model from the base specification library, see an example below:
 
 ```typespec
-import "@opportunity-stream/core"; // Import the base specification library
+import "@common-grants/core"; // Import the base specification library
 
 // Allows us to use models defined in the specification library
-// without prefixing each model with `OpportunityStream.Models.`
-using OpportunityStream.Models;
+// without prefixing each model with `CommonGrants.Models.`
+using CommonGrants.Models;
 
 namespace CustomAPI.CustomModels;
 
@@ -89,10 +89,10 @@ model CustomOpportunity extends Opportunity {
 And finally this custom field can be used to override the the routes from the base specification library.
 
 ```typespec
-import "@opportunity-stream/core";
+import "@common-grants/core";
 import "./models.tsp"; // Import the custom field and model from above
 
-using OpportunityStream;
+using CommonGrants;
 using Http;
 
 namespace CustomAPI.CustomRoutes;

examples/custom-api/package.json

@@ -14,7 +14,7 @@
     "docs": "npm run typespec && npm run docs:build && npm run docs:preview"
   },
   "peerDependencies": {
-    "@opportunity-stream/core": "file:../../specs/opportunity-stream-core-0.1.0-alpha.2.tgz",
+    "@common-grants/core": "file:../../specs/common-grants-core-0.1.0-alpha.3.tgz",
     "@typespec/compiler": "^0.63.0"
   },
   "private": true,

examples/custom-api/src/models.tsp

@@ -1,8 +1,8 @@
-import "@opportunity-stream/core";
+import "@common-grants/core";
 import "@typespec/json-schema";
 
 using JsonSchema;
-using OpportunityStream;
+using CommonGrants;
 
 @jsonSchema
 namespace CustomAPI.CustomModels;

examples/custom-api/src/routes.tsp

@@ -1,11 +1,11 @@
 import "@typespec/http";
 import "@typespec/rest";
 
-import "@opportunity-stream/core";
+import "@common-grants/core";
 
 import "./models.tsp";
 
-using OpportunityStream;
+using CommonGrants;
 using Http;
 
 namespace CustomAPI.CustomRoutes;