Skip to content

Commit 8429419

Browse files
committed
Add 3 min delay to workflow to wait for pypi.
1 parent c5ae9f1 commit 8429419

File tree

2 files changed

+52
-7
lines changed

2 files changed

+52
-7
lines changed

.github/workflows/build_docker.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Build Docker Image
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
release:
8+
types: [created]
9+
10+
jobs:
11+
docker:
12+
runs-on: ubuntu-latest
13+
steps:
14+
-
15+
name: Checkout
16+
uses: actions/checkout@v3
17+
-
18+
name: Delay for 3 Docker build until PyPI is updated.
19+
run: |
20+
echo "Waiting 3 minutes for PyPI to update..."
21+
sleep 180
22+
-
23+
name: Set up QEMU
24+
uses: docker/setup-qemu-action@v2
25+
-
26+
name: Set up Docker Buildx
27+
uses: docker/setup-buildx-action@v2
28+
-
29+
name: Login to Docker Hub
30+
uses: docker/login-action@v2
31+
with:
32+
username: ${{ secrets.DOCKERHUB_USERNAME }}
33+
password: ${{ secrets.DOCKERHUB_TOKEN }}
34+
-
35+
name: Build and push
36+
uses: docker/build-push-action@v4
37+
with:
38+
context: .
39+
platforms: linux/amd64,linux/arm/v7,linux/arm64/v8
40+
push: true
41+
tags: zeroxeli/readme-ai:latest

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Automatically generate beautiful README files powered by AI
1212
---
1313

1414
## Quick Links
15-
* [Introduction](#objective)
15+
* [Overview](#overview)
1616
* [Demo](#demo)
1717
* [Features](#features)
1818
* [Getting Started](#getting-started)
@@ -26,20 +26,24 @@ Automatically generate beautiful README files powered by AI
2626

2727
<table>
2828
<tr>
29-
<td width="45%">
29+
<td width="55%">
3030
<p>Objective</p>
31-
Readme-ai is a dev tool that auto-generates detailed README.md files from the command-line using OpenAI's GPT models. Provide a repository URL or local directory path, and <em>README-AI</em> builds a well-structured README.md for your project.<br><hr>
31+
Readme-ai is a dev tool that auto-generates detailed README.md files from the command-line using OpenAI's GPT models. Provide a repository URL or local directory path, and <em>README-AI</em> builds a well-structured README.md for your project.<br><br>
32+
3233
<p>Motivation</p>
33-
Streamlines documentation creation and maintenance, enhancing developer productivity. <em>README-AI</em> aims to improve the adoption of open-source software, enabling all skill levels and disciplines to understand, utilize, and contribute to projects more effectively.<hr>
34+
Streamlines documentation creation and maintenance, enhancing developer productivity. <em>README-AI</em> aims to improve the adoption of open-source software, enabling all skill levels and disciplines to understand, utilize, and contribute to projects more effectively.<br>
3435

35-
> [!WARNING]
36-
>
37-
> This project is under development with an opinionated setup. It is vital to review the text generated by the OpenAI API to ensure it accurately represents your codebase.
3836
</p></td>
3937
<td width="55%"><img src="https://github.com/eli64s/readme-ai/blob/main/examples/images/dalle-readmeai.png?raw=true" width="100%"></td>
4038
</tr>
4139
</table>
4240

41+
> [!WARNING]
42+
>
43+
> This project is under development with an opinionated setup. It is vital to review the text generated by the OpenAI API to ensure it accurately represents your codebase.
44+
45+
<br>
46+
4347
---
4448

4549
## Demo

0 commit comments

Comments
 (0)