Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
npole0103 authored Oct 20, 2022
1 parent db91843 commit b369b1f
Showing 1 changed file with 25 additions and 15 deletions.
40 changes: 25 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@

## What is the ALREADYME.md?
![ALREADME-MAIN](https://user-images.githubusercontent.com/37138188/196944432-82a559ee-5b10-4981-88e6-ca1c76f04313.gif)
ALREADYME is a multiplatform desktop application which create a README.md. If you input your github repository, it will analyze source codes of the repository and create README.md using AI. Let's create README.md of repository with only one-click.
ALREADYME is a multiplatform desktop application which create a `README.md`. If you input your github repository, it will analyze source codes of the repository and create `README.md` using AI. Let's create `README.md` of repository with only one-click.

---

<br>

## Development Environment
- Java `@17.x`
- JDK `@17.x`
- MySQL `@8.x`
- Spring Boot `@2.7.2`
- Spring Data JPA
Expand Down Expand Up @@ -91,22 +91,32 @@ ai-server.host=

## Features

- The start of creating README.md
- The start of creating `README.md`
- Enter GitHub repository URL
- WEB URL
- ".git" URL
- The process of creating README.md
- Loading View
- Repository Cloning
- Web URL
- `".git"` URL
- The process of creating `README.md`
- Loading view
- Repository cloning
- Real-time loading of the creation process
- The complete of creating README.md
- Donwload README.md
- The complete of creating `README.md`
- Donwload `README.md`
- Select a file download location
- Download Markdown file
- Pull-Request README.md
- Pull-Request to original repository from [@ALREADYME-BOT](https://github.com/ALREADYME-BOT) repository
- Open Web URL after Pull-Request is completed

- Download markdown file
- Pull-Request `README.md`
- Pull-request to original repository from [@ALREADYME-BOT](https://github.com/ALREADYME-BOT) repository
- Open web URL after pull-request is completed

---

<br>

## [ALREADYME-BOT](https://github.com/ALREADYME-BOT)

![image](https://user-images.githubusercontent.com/37138188/196955332-85957470-3b89-4568-9780-aaf5b6c2237d.png)

ALREADME-BOT is that helps create README.md. The bot can fork the original repository. And add README.md generated by AI to the Forked repository. Finally, ALREADEME-BOT helps you pull-request the original repository.

---

<br>
Expand Down

0 comments on commit b369b1f

Please sign in to comment.