Skip to content

Commit b17964e

Browse files
authored
Update README.md
1 parent fa41968 commit b17964e

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,31 @@ This is a starter template for building a Next.js application that fetches data
2626

2727
## Overview
2828

29+
### What's included?
30+
31+
✅ Type-safe data layer with the WordPress RestAPI
32+
✅ Setup for all basic WordPress options: Posts, Pages, Authors, Categories, Tags
33+
✅ Easy integration with custom post types and ACF
34+
✅ Dynamic routes for Posts and Pages
35+
✅ Design system for layout and prose styling ([craft-ds.com](https://craft-ds.com))
36+
✅ Filter, Search, and Card components
37+
✅ Dynamically rendered sitmap
38+
✅ Dynamically generated metadata
39+
✅ Responsive Nav and Footer components
40+
✅ Site configuration file
41+
✅ Menu configuration file
42+
43+
### Important files
44+
2945
- `lib/wordpress.ts` -> Functions for fetching WordPress CMS via Rest API with cache tags
30-
- `lib/wordpress.d.ts` -> Type declarations for WP Rest API
46+
- `lib/wordpress.d.ts` -> Type declarations for the WordPress Rest API
47+
- `components/craft.tsx` -> Handles the design system for the site and prose styling
3148
- `components/posts/post-card.tsx` -> Component and styling for posts
32-
- `app/posts/filter.tsx` -> Component for handling filtering of posts
33-
- `/menu.config.ts` -> Site nav menu configuration for desktop and mobile
34-
- `/site.config.ts` -> Configuration for `sitemap.ts`
49+
- `components/posts/filter.tsx` -> Filter component for Posts
50+
- `components/posts/search-input.tsx` -> Search component for Posts
51+
- `menu.config.ts` -> Site nav menu configuration for desktop and mobile
52+
- `site.config.ts` -> Configuration for `sitemap.ts` and more
3553
- `app/sitemap.ts` -> Dynamically generated sitemap
36-
- `app/api/revalidate/route.ts` -> Webhook endpoint for content revalidation
37-
- `wordpress/next-revalidate/` -> WordPress plugin for automatic revalidation
3854

3955
The following environment variables are required in your `.env.local` file:
4056

0 commit comments

Comments
 (0)