Skip to content

Commit

Permalink
Add copyright license and update repository information
Browse files Browse the repository at this point in the history
  • Loading branch information
ehsanghaffar committed Oct 26, 2023
1 parent e633eaa commit 1bb5e6c
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 12 deletions.
20 changes: 20 additions & 0 deletions LICENCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2023 Ehsan Ghaffar

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# BioGPT

![GitHub repo size](https://img.shields.io/github/repo-size/your-username/your-repo-name)
![GitHub issues](https://img.shields.io/github/issues/your-username/your-repo-name)
![GitHub stars](https://img.shields.io/github/stars/your-username/your-repo-name)
![GitHub forks](https://img.shields.io/github/forks/your-username/your-repo-name)
![GitHub license](https://img.shields.io/github/license/your-username/your-repo-name)
![GitHub repo size](https://img.shields.io/github/repo-size/ehsanghaffar/biogpt)
![GitHub issues](https://img.shields.io/github/issues/ehsanghaffar/biogpt)
![GitHub stars](https://img.shields.io/github/stars/ehsanghaffar/biogpt)
![GitHub forks](https://img.shields.io/github/forks/ehsanghaffar/biogpt)
![GitHub license](https://img.shields.io/github/license/ehsanghaffar/biogpt)

Create engaging social media bios with ease using the Social Media Bio Generator! This web application generates unique and personalized social media bios based on user input and offers different vibes to choose from.

Expand Down Expand Up @@ -40,13 +40,13 @@ To run this application locally, follow these steps:
1. Clone this repository to your local machine:

```bash
git clone https://github.com/ehsanghaffar/biogpt your-repo-name
git clone https://github.com/ehsanghaffar/biogpt
```

2. Navigate to the project directory:

```bash
cd your-repo-name
cd biogpt
```

3. Install the required dependencies:
Expand All @@ -65,7 +65,7 @@ To run this application locally, follow these steps:

## Usage

1. Visit the web application at [https://bio.ehsanghaffarii.ir/](https://bio.ehsanghaffarii.ir/).
1. Visit the web application at [your-website-url](https://bio.ehsanghaffarii.ir/).

2. Enter a short description about yourself or the person for whom you want to create a social media bio.

Expand Down Expand Up @@ -136,7 +136,3 @@ We welcome contributions from the open-source community. If you'd like to contri
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

**Note**: Don't forget to replace the placeholders such as `your-username`, `your-repo-name`, and `your-website-url` with your actual GitHub information and website URL. Also, ensure that the Docker Compose section accurately reflects your project's setup.

Happy coding and enjoy using the Social Media Bio Generator!

0 comments on commit 1bb5e6c

Please sign in to comment.