Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisWhisker committed Apr 22, 2024
1 parent c7969f3 commit e308b22
Showing 1 changed file with 15 additions and 30 deletions.
45 changes: 15 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,21 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# Elden Scribe

## Getting Started
Elden Scribe is a web application built with Next.js and React, designed to assist players of Elden Ring in quickly and easily constructing messages using the game's extensive vocabulary. Gone are the days of scrolling through long lists of words in each category to find the right one. With Elden Scribe, you can filter all the words in the game, construct messages by piecing together different parts, and view their categories to locate them more easily in the game.

First, run the development server:
## Technologies Used

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
- [Next.js](https://nextjs.org/): React framework for building server-rendered applications.
- [React](https://reactjs.org/): JavaScript library for building user interfaces.
- [TypeScript](https://www.typescriptlang.org/): Typed superset of JavaScript that compiles to plain JavaScript.
- [Tailwind CSS](https://tailwindcss.com/): Utility-first CSS framework for styling.
- [React Hook Form](https://react-hook-form.com/): Library for managing form state in React.
- [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/): Tools for code linting and formatting.

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Contributing

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
Contributions are welcome! If you'd like to contribute to Elden Scribe, please follow these steps:

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
1. Fork the repository and create your branch from `main`.
2. Make your changes and ensure the code passes linting checks.
3. Test your changes thoroughly.
4. Open a pull request describing the changes you've made.

0 comments on commit e308b22

Please sign in to comment.