Skip to content

Commit 3e1bff3

Browse files
committed
chore: update readme
1 parent 2e3a752 commit 3e1bff3

File tree

1 file changed

+2
-24
lines changed

1 file changed

+2
-24
lines changed

README.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,25 +29,17 @@ This is a starter template for building a Next.js application that fetches data
2929
### What's included?
3030

3131
✅ Type-safe data layer with the WordPress RestAPI
32-
32+
✅ Granualar access to revalidation and cache tags
3333
✅ Setup for all basic WordPress options: Posts, Pages, Authors, Categories, Tags
34-
3534
✅ Easy integration with custom post types and ACF
36-
3735
✅ Dynamic routes for Posts and Pages
38-
3936
✅ Design system for layout and prose styling ([craft-ds.com](https://craft-ds.com))
40-
4137
✅ Filter, Search, and Card components
42-
4338
✅ Dynamically rendered sitemap
44-
4539
✅ Dynamically generated metadata
46-
40+
✅ Dynamically generated OG/Twitter Cards for Posts and pages
4741
✅ Responsive Nav and Footer components
48-
4942
✅ Site configuration file
50-
5143
✅ Menu configuration file
5244

5345
### Important files
@@ -97,49 +89,35 @@ const defaultFetchOptions = {
9789
#### Posts
9890

9991
- `getAllPosts(filterParams?: { author?: string; tag?: string; category?: string; })`: Fetches posts with optional filtering by author, tag, or category. Uses cache tags for efficient revalidation.
100-
10192
- `getPostById(id: number)`: Retrieves a specific post by ID with proper error handling.
102-
10393
- `getPostBySlug(slug: string)`: Fetches a post using its URL-friendly slug.
10494

10595
#### Categories
10696

10797
- `getAllCategories()`: Retrieves all categories with cache invalidation support.
108-
10998
- `getCategoryById(id: number)`: Gets a specific category with error handling.
110-
11199
- `getCategoryBySlug(slug: string)`: Fetches a category by its slug.
112-
113100
- `getPostsByCategory(categoryId: number)`: Gets all posts in a category, using proper cache tags.
114101

115102
#### Tags
116103

117104
- `getAllTags()`: Fetches all available tags.
118-
119105
- `getTagById(id: number)`: Retrieves a specific tag.
120-
121106
- `getTagBySlug(slug: string)`: Gets a tag by its slug.
122-
123107
- `getTagsByPost(postId: number)`: Fetches all tags associated with a post.
124-
125108
- `getPostsByTag(tagId: number)`: Gets all posts with a specific tag.
126109

127110
#### Pages
128111

129112
- `getAllPages()`: Retrieves all WordPress pages.
130-
131113
- `getPageById(id: number)`: Gets a specific page by ID.
132-
133114
- `getPageBySlug(slug: string)`: Fetches a page by its slug.
134115

135116
#### Authors
136117

137118
- `getAllAuthors()`: Fetches all WordPress authors.
138-
139119
- `getAuthorById(id: number)`: Gets a specific author.
140-
141120
- `getAuthorBySlug(slug: string)`: Retrieves an author by slug.
142-
143121
- `getPostsByAuthor(authorId: number)`: Gets all posts by a specific author.
144122

145123
#### Media

0 commit comments

Comments
 (0)