Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
rknyryn committed Mar 22, 2024
1 parent 13e4b7d commit 43a545b
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 20 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Kaan Yarayan

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.
53 changes: 33 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,51 @@
# create-svelte
# Daily Words (English Vocabulary App)

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
This application is a simple tool designed to enhance your English vocabulary by providing you with nine new words every day along with their meanings and example usages.

## Creating a project
## Features

If you're seeing this, you've probably already done this step. Congrats!
- **Daily Vocabulary:** Receive nine new English words daily to expand your vocabulary.
- **Meanings and Examples:** Each word comes with its meaning and example sentences for better understanding.
- **Clean Interface:** Simple and intuitive design for easy navigation and focus on learning.

```bash
# create a new project in the current directory
npm create svelte@latest
## Getting Started

# create a new project in my-app
npm create svelte@latest my-app
```
You can access our website by visiting [Daily Words](https://rknyryn.github.io/daily-english-words-web/).

## Contributing

We welcome contributions! If you have ideas for new features, improvements, or bug fixes, please don't hesitate to open an issue or submit a pull request on our [Github repository](https://github.com/rknyryn/daily-english-words-web).

## Developing
## Installation

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
1. Clone repository:

```bash
npm run dev
git clone https://github.com/rknyryn/daily-english-words-web.git
```

2. Navigate into the project directory:

# or start the server and open the app in a new browser tab
npm run dev -- --open
```bash
cd daily-english-words-web
```

## Building
3. Install dependencies:

```bash
npm install
```

To create a production version of your app:
4. Start the development server:

```bash
npm run build
npm run dev
```

You can preview the production build with `npm run preview`.
## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/rknyryn/daily-english-words-web/blob/main/LICENSE) file for details.

---

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
Happy learning! 📚📝🌟

0 comments on commit 43a545b

Please sign in to comment.