Skip to content

Commit a6bb8cf

Browse files
authored
docs: Adds Examples to README (#17)
fix: Type documentation link.
1 parent 17487ea commit a6bb8cf

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<br/>
44
<strong>🧪 BETA 🧪</strong>
55
<br/>
6-
<strong>This is template repository used to generate a static Globus-powered research search portal.</strong>
6+
<strong>This is a template repository used to generate a serverless Globus-powered research search portal.</strong>
77
<br/>
88
</p>
99

1010
----
1111

1212
View the result at: [globus.github.io/template-search-portal](https://globus.github.io/template-search-portal).
1313

14-
While this repository is a working example of a search portal, it is also a template for [creating your own static research search portal](#creating-your-own-static-research-search-portal).
14+
While this repository is a working example of a search portal, it is also a template for [creating your own research search portal](#creating-your-own-static-research-search-portal).
1515

1616
----
1717

@@ -33,7 +33,14 @@ While this repository is a working example of a search portal, it is also a temp
3333

3434
- 🤖 **Dependabot** – A default [Dependabot](https://docs.github.com/en/code-security/dependabot) configuration ([`.github/dependabot.yml`](.github/dependabot.yml)) to keep your repository up-to-date with latest changes to [globus/static-search-portal](https://github.com/globus/static-search-portal).
3535

36-
### Creating Your Own Static Research Search Portal
36+
# Examples
37+
Example implementations of the Search Portal showing various capabilities – reviewing (and even copying) the `static.json` files can be a great starting point for your own portal.
38+
39+
- [@globus/example-search-portal-with-embeds](https://github.com/globus/example-search-portal-with-embeds)
40+
- [@globus/example-search-portal-with-transfer](https://github.com/globus/example-search-portal-with-transfer)
41+
- [@globus/example-search-portal-with-github-action-ingest](https://github.com/globus/example-search-portal-with-github-action-ingest)
42+
43+
# Creating Your Own Static Research Search Portal
3744

3845
1. Create a new repository from the [globus/template-search-portal](https://github.com/globus/template-search-portal) template.
3946
* Using the following URL: https://github.com/new?template_name=template-search-portal&template_owner=globus
@@ -72,8 +79,7 @@ The type used for `data` by the [@globus/static-search-portal generator](https:/
7279

7380
#### Type declaration
7481

75-
See: https://github.com/globus/static-search-portal/blob/main/docs/modules.md#data
76-
82+
See: https://github.com/globus/static-search-portal/blob/main/docs/type-aliases/Static.md
7783

7884
#### Field Types
7985

0 commit comments

Comments
 (0)