inicontent 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +23 -25
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -44,40 +44,38 @@ schema field types, flows, routing).
44
44
 
45
45
  There are two ways to use this project:
46
46
 
47
- ### 1. Recommended Method: Add as a Nuxt Layer
47
+ ### 1. Recommended Method: Install from npm and Add as a Nuxt Layer
48
48
 
49
- The easiest way to integrate Inicontent CMS is to use it as a Nuxt Layer.
49
+ The easiest way to integrate Inicontent CMS is to install it from npm and use it as a Nuxt Layer.
50
50
 
51
51
  **Steps:**
52
- 1. Add the repository as a layer in your `nuxt.config` file.
53
- 2. Remove your existing `app.vue` file to avoid conflicts.
54
- 3. To override specific admin routes, create corresponding files in the `pages` directory. These will automatically override the default routes provided by the CMS.
55
-
56
- **Database Configuration:**
57
- - By default, the CMS is a multi-database manager.
58
- - When no `database` is set in `.env`, the admin interface (`/admin`) will display all available databases. Users can then navigate to a specific database's admin panel at `/admin/<dbName>`.
59
- - If a `database` is specified in `.env`, the `/admin` route will directly display the tables for the specified database, removing the need to include the database name in the path.
60
-
61
- **Example Configuration:**
62
-
63
- ```javascript
64
- // nuxt.config.ts
65
- export default defineNuxtConfig({
66
- extends: [["github:inicontent/inicontent", { install: true }]]
67
- });
68
- ```
52
+
53
+ 1. Install the package:
54
+ ```bash
55
+ npm install inicontent
56
+ ```
57
+ (or `pnpm add inicontent`, `yarn add inicontent`, `bun add inicontent`)
58
+ 2. Add it as a layer in your `nuxt.config` file:
59
+ ```javascript
60
+ // nuxt.config.ts
61
+ export default defineNuxtConfig({
62
+ extends: ["inicontent"]
63
+ });
64
+ ```
65
+ 3. Remove your existing `app.vue` file to avoid conflicts.
66
+ 4. To override specific admin routes, create corresponding files in the `pages` directory. These will automatically override the default routes provided by the CMS.
67
+
68
+ **Database Configuration:**
69
+ - By default, the CMS is a multi-database manager.
70
+ - When no `database` is set in `.env`, the admin interface (`/admin`) will display all available databases. Users can then navigate to a specific database's admin panel at `/admin/<dbName>`.
71
+ - If a `database` is specified in `.env`, the `/admin` route will directly display the tables for the specified database, removing the need to include the database name in the path.
69
72
 
70
73
  ```sh
71
74
  # .env
72
75
  database=DATABASE_SLUG
73
76
  ```
74
77
 
75
- **Database configuration:**
76
- - The CMS is a multi-database manager by default.
77
- - When no `database` is set in `.env`, `/admin` lists all available databases; users navigate to a specific database's admin panel at `/admin/<dbName>`.
78
- - When `database` is set, `/admin` shows that database's tables directly, without the name in the path.
79
-
80
- This method keeps your project clean and makes updates to the CMS easy.
78
+ This method keeps your project clean and makes updates to the CMS easy: you stay on the `inicontent` version pinned in your `package.json` and upgrade intentionally with `npm update inicontent`.
81
79
 
82
80
  ### 2. Advanced Method: Clone and Edit the Repository
83
81
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "inicontent",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "type": "module",
5
5
  "main": "./nuxt.config.ts",
6
6
  "dependencies": {