Skip to content

Commit a7efe20

Browse files
authored
Update README
1 parent 2255c0e commit a7efe20

File tree

1 file changed

+52
-24
lines changed

1 file changed

+52
-24
lines changed

README.md

Lines changed: 52 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,65 @@
22

33
![landy](https://user-images.githubusercontent.com/48876996/100373174-cd393880-3023-11eb-9fef-8acdf9733120.gif)
44

5-
Landy is a free React landing page template designed for developers and startups, who want to create a quick and professional landing page for their business or project.
5+
[Landy][Landy] is a free React landing page template designed for developers and startups, who want to create a quick and professional landing page for their business or project.
66

77
This React template comes with multi-lingual support, smooth animations, set of ready to use sections and most importantly, all of the content is stored in the JSON files, so that you can manage the texts without having any prior knowledge in React.js.
88

9+
## Table of contents
910

11+
- [Features](#features)
12+
- [Google Lighthouse](#google-lighthouse)
13+
- [Performance](#performance)
14+
- [Accessibility](#accessibility)
15+
- [Best Practices](#best-practices)
16+
- [SEO](#seo)
17+
- [Demo](#demo)
18+
- [Installation](#installation)
19+
- [Special Thanks](#special-thanks)
20+
- [Usage](#usage)
21+
- [License](#license)
22+
23+
## Features
24+
25+
Your project will have everything you need to build a modern single-page React app:
26+
27+
- 🎁 **Modern** – Template created using the latest features of React (State management using Hooks, Code-Splitting to reduce the bundle size)
28+
- 🏷 **Responsive** – Highly responsive and reusable UI components, that change depending on the provided props
29+
- 🚀 **Fast** – Buttery smooth experience thanks to the implementation of best practices and no third party dependencies, resulting in <b>PERFECT</b> Google Lighthouse scores
30+
- 🌍 **Internationalization** - Prebuilt standalone file that works in every environment and doesn't require reloading the page to translate the content
31+
- 🛸 **Routing** - Each file inside the src/pages directory will generate its own route, so you don't have to manually handle the routing
32+
- 🤙 **Contact Form** - Contact form written in React Hooks, with uncontrolled form validation to reduce unnecessary performance penalty. You just need to provide the endpoint
33+
- ⚙️ **Maintenance** - All of the content is stored in the JSON files, so that you can easily manage the content of the website
1034

1135
## Google Lighthouse
36+
1237
![1](https://user-images.githubusercontent.com/48876996/104335960-555c9a00-550d-11eb-8e94-4549637f72bd.PNG)
1338

39+
[Google Lighthouse][Google Lighthouse] is an open-source, automated tool for measuring the quality of web pages. Google Lighthouse audits performance, accessibility and search engine optimization of web pages.
40+
41+
### Performance
42+
43+
Audits for metrics like first paint and time to interactive to determine lag.
44+
45+
### Accessibility
46+
47+
Checks for common issues that may prevent users from accessing your content.
48+
49+
### Best Practices
50+
51+
Looks for everything from HTTPS usage to correct image aspect ratios.
52+
53+
### SEO
54+
55+
Checks for best practices to ensure your site is discoverable.
56+
1457

1558
## Demo
1659

1760
Check the live demo here 👉️ https://landy.website/
1861

1962

20-
### Creating an App
63+
### Installation
2164

2265
You’ll need to have Node 10.16.0 or later version on your local development machine (but it’s not required on the server). I recommend using the latest LTS version.
2366

@@ -35,25 +78,11 @@ npm start
3578

3679
## What's included
3780

38-
- [axios][axios]
39-
- [antd][antd]
40-
- [react-reveal][react-reveal]
41-
- [react-svg][react-svg]
42-
- [styled-componets][styled-componets]
43-
- [i18next][i18next]
44-
- [@loadable/component][@loadable/component]
45-
46-
## Quick Overview
47-
48-
Your project will have everything you need to build a modern single-page React app:
49-
50-
- Fast and lightweight landing page template using React.
51-
- Highly responsive and reusable UI components, that change depending on the provided props.
52-
- Styling with styled-components and antd.
53-
- Autoprefixed CSS, so you don’t need -webkit- or other prefixes.
54-
- Multi-lingual support using i18next.
55-
- Contact form written in React Hooks, with uncontrolled form validation to reduce any unnecessary performance penalty.
56-
- Content data in the JSON files, so that you can easily manage the content of the website.
81+
- [axios][axios] - Promise based HTTP client for the browser and node.js
82+
- [antd][antd] - React UI library that contains a set of high quality components.
83+
- [react-reveal][react-reveal] - High performance animation library for React.
84+
- [styled-componets][styled-componets] - Variant on “CSS-in-JS”—which solves many of the problems with traditional CSS.
85+
- [i18next][i18next] - Internationalization-framework written in and for JavaScript.
5786

5887
## Special thanks
5988

@@ -71,10 +100,9 @@ Licensed under the MIT license.
71100
[axios]: https://github.com/axios/axios
72101
[antd]: https://github.com/ant-design/ant-design
73102
[react-reveal]: https://github.com/rnosov/react-reveal
74-
[react-svg]: https://www.npmjs.com/package/react-svg
75103
[styled-componets]: https://github.com/styled-components/styled-components
76104
[i18next]: https://github.com/i18next/i18next
77-
[@loadable/component]: https://www.npmjs.com/package/@loadable/component
78105
[whoooa]: https://www.whoooa.rocks/
79-
106+
[Landy]: https://www.npmjs.com/package/cra-template-adrinlol
107+
[Google Lighthouse]: https://developers.google.com/web/tools/lighthouse
80108
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)