Skip to content

Commit d28cc8a

Browse files
committed
docs: update README to reflect multi-lingual site construction
The README has been substantially revised to reflect that the project is now focused on using Next.js and Lingui to build a multi-lingual website. It now provides an overview of the project, details key features, and offers a step-by-step guide to getting started. The update also includes methods of contribution and license information. This is to better instruct users on how to use the updated website and encourage contributions.
1 parent b81fe56 commit d28cc8a

File tree

1 file changed

+44
-13
lines changed

1 file changed

+44
-13
lines changed

README.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,53 @@
1-
## Getting Started
1+
## Next.js & Lingui: Building a Multi-Lingual Website
22

3-
First, run the development server:
3+
[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/nekofar/nextjs-lingui-starter?include_prereleases)](https://github.com/nekofar/nextjs-lingui-starter/releases)
4+
[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/nekofar/nextjs-lingui-starter/build.yml)](https://github.com/nekofar/nextjs-lingui-starter/actions/workflows/build.yml)
5+
[![GitHub](https://img.shields.io/github/license/nekofar/nextjs-lingui-starter)](https://github.com/nekofar/nextjs-lingui-starter/blob/master/LICENSE)
6+
[![Twitter Follow](https://img.shields.io/badge/follow-%40nekofar-1DA1F2?logo=twitter&style=flat)](https://twitter.com/nekofar)
7+
[![Donate](https://img.shields.io/badge/donate-nekofar.crypto-a2b9bc?logo=ko-fi&logoColor=white)](https://ud.me/nekofar.crypto)
48

5-
```bash
6-
pnpm dev
7-
```
89

9-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
10+
### Overview
1011

11-
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
12+
Welcome to the Next.js & Lingui starter project! This repository demonstrates the seamless integration of Next.js, a
13+
powerful React framework for building server-side rendered applications, with Lingui, the ultimate solution for
14+
multi-lingual support in web projects.
1215

13-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
16+
Our goal is to showcase the process of creating a multi-lingual website that caters to a diverse global audience. With
17+
Next.js providing performance and SEO advantages, and Lingui simplifying translation management, this demo project
18+
highlights the best practices for internationalization and localization.
1419

15-
## Learn More
20+
### Key Features
1621

17-
To learn more about Next.js, take a look at the following resources:
22+
* **Next.js Benefits**: Experience the advantages of using Next.js for server-side rendering, static site generation, and
23+
client-side routing. Learn how it enhances performance, SEO, and simplifies development.
24+
* **Lingui's Power**: Explore Lingui's capabilities in handling translations, message extraction, language pluralization,
25+
and locale-specific formatting.
26+
* **Dynamic Language Switching**: Witness real-time language switching, enabling users to seamlessly toggle between
27+
different languages without losing their place on the site.
1828

19-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
20-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
29+
### Getting Started
2130

22-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
31+
Click on `Use this template` to create the repo for your app.
32+
33+
Then, to use this project template, follow these steps:
34+
35+
1. Clone this repository: `git clone https://github.com/your-username/your-repo.git`
36+
2. Navigate to the project directory: `cd your-repo`
37+
3. Install project dependencies: `pnpm install`
38+
4. Start the development server: `pnpm run dev`
39+
5. Open your browser and visit http://localhost:3000 to see the application in action.
40+
41+
### Contributing
42+
43+
We welcome contributions to this project! To contribute, follow these steps:
44+
45+
1. Fork the repository
46+
2. Create a new branch: `git checkout -b your-feature`
47+
3. Make your changes and commit them: `git commit -m "Add your feature"`
48+
4. Push to the branch: `git push origin your-feature`
49+
5. Open a pull request to the main branch of this repository
50+
51+
### License
52+
53+
This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)