Skip to content

Commit 135b28d

Browse files
authored
Add embed section to readme (#229)
Signed-off-by: Sergio Castaño Arteaga <[email protected]>
1 parent f26e24b commit 135b28d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@
1313
| ------------------------------------------------------- | ------------------------------------------------------- |
1414
| ![Screenshot 3](docs/screenshots/gitjobs3.png?raw=true) | ![Screenshot 4](docs/screenshots/gitjobs4.png?raw=true) |
1515

16+
## Embed
17+
18+
**GitJobs** allows other websites to embed a view to display the jobs that match certain criteria. You can, for example, list jobs that offer time to work on a specific project, or jobs related to any of the projects in a given foundation. Any criteria supported by the filters can be used to create an embed view. The embed code is a simple iframe that can be added to any website.
19+
20+
To setup yours, the first step is to adjust the filters as if you were searching for jobs. Once you have the desired filters, you can click on the `Get embed code` button, at the bottom of the filters. This will open a modal with the ready to use embed code.
21+
22+
You can see it in action in this [example](https://codepen.io/cynthiasg/pen/gbOJLOb).
23+
1624
## Contributing
1725

1826
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
@@ -23,4 +31,4 @@ This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundati
2331

2432
## License
2533

26-
GitJobs is an open source project licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
34+
**GitJobs** is an open source project licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

0 commit comments

Comments
 (0)