Skip to content

Commit 9b766c9

Browse files
committed
Update docs and dependencies
1 parent e95d8e9 commit 9b766c9

File tree

7 files changed

+173
-150
lines changed

7 files changed

+173
-150
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2019 George Raptis
3+
Copyright (c) 2019-present George Raptis
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+21-14
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
<p align="center">
2-
<img src="src/assets/app-icons/logo.png" width="150" height="150" alt="Meme Generator">
3-
</p>
4-
5-
<h1 align="center">Meme Generator</h1>
1+
# Meme Generator
62

73
A Progressive Web App (PWA) for creating memes.
84

9-
The application is built with web technologies such as HTML, CSS, and JavaScript. It uses the [Canvas API](https://developer.mozilla.org/docs/Web/API/Canvas_API) to draw the meme text on the image. Processing the image and text is done client-side, so no data is sent to any server.
5+
## About
6+
7+
This is a web application that allows users to create memes by adding text to images.
8+
The application is built with web technologies such as HTML, CSS, and JavaScript.
9+
It uses the [Canvas API](https://developer.mozilla.org/docs/Web/API/Canvas_API) to draw the meme text on the image.
10+
Processing the image and text is done client-side, so no data is sent to any server.
11+
12+
## Live demo
13+
14+
👉 [Meme Generator](https://georapbox.github.io/meme-generator/)
1015

1116
## Features
1217

13-
Create a meme with by:
18+
Some of the key features of the application include creating memes by:
1419
- Selecting an image from your device
1520
- Selecting an image from the web (by URL)
1621
- Selecting an image from the gallery
@@ -19,7 +24,9 @@ Create a meme with by:
1924

2025
## Screenshots
2126

22-
![meme](src/assets/app-icons/screenshots/screenshot.png)
27+
The following screenshots show the application in action:
28+
29+
![meme](screenshots/screenshot.png)
2330

2431
## Development
2532

@@ -34,21 +41,21 @@ Below are the instructions for setting up the development environment.
3441

3542
Clone the repository to your local machine:
3643

37-
```bash
44+
```sh
3845
git clone [email protected]:georapbox/meme-generator.git
3946
```
4047

4148
Navigate to the project's directory and install the dependencies:
4249

43-
```bash
50+
```sh
4451
npm install
4552
```
4653

4754
### Running the application
4855

4956
To run the application in development mode, run the following command:
5057

51-
```bash
58+
```sh
5259
npm start -- --open
5360
```
5461

@@ -58,7 +65,7 @@ This will start the development server and open the application in your default
5865

5966
To build the application for production, run the following command:
6067

61-
```bash
68+
```sh
6269
npm run build
6370
```
6471

@@ -68,12 +75,12 @@ This will create a `dist` directory containing the production build of the appli
6875

6976
To deploy the application, run the following command:
7077

71-
```bash
78+
```sh
7279
npm run deploy
7380
```
7481

7582
This will build the application first and then deploy it to GitHub Pages in the `gh-pages` branch.
7683

7784
## License
7885

79-
[The MIT License (MIT)](https://georapbox.mit-license.org/@2019)
86+
[The MIT License (MIT)](https://github.com/georapbox/meme-generator/blob/master/LICENSE)

0 commit comments

Comments
 (0)