Changeset 3217381

Timestamp:

01/06/2025 04:35:23 AM (14 months ago)

Author:

archisketch

Message:

fix: updated readme guidelines

File:

• archisketch-3d-interior-design-solution/trunk/readme.txt (modified) (1 diff)

archisketch-3d-interior-design-solution/trunk/readme.txt

@@ -1 @@
-=== Archisketch - 3D Interior Design Solution ===
-Contributors: archisketch
-Tags: interior, furniture, 3D, AR, VR
-Requires at least: 5.6
-Tested up to: 6.7
-Stable tag: 1.1.0
-Requires PHP: 7.2
-License: GPLv2 or later
-License URI: https://www.gnu.org/licenses/gpl-2.0.html
+=== Archisketch – 3D Interior Design Solution ===
+Contributors: archisketch  
+Tags: 3D interior, 3D furniture, AR, VR, floor plans  
+Requires at least: 5.6  
+Tested up to: 6.7  
+Stable tag: 1.1.0  
+Requires PHP: 7.2  
+License: GPLv2 or later  
+License URI: https://www.gnu.org/licenses/gpl-2.0.html  
 
 Archisketch is a 3D interior CRM using AR/VR, 2D/3D floor plans, and render images to attract visitors and support online businesses.
 
-== Description ==
-Archisketch is a 3D interior CRM using AR/VR, 2D/3D floor plans, and render images to attract visitors and support online businesses.
+== Description ==  
+Archisketch is a 3D interior CRM enabling businesses to integrate AR/VR, 2D/3D floor plans, and realistic render images into their websites. It enhances visitor engagement and supports online businesses with interactive design tools.
 
-== How to use ==
-1. Click `Add Plugins` in the WordPress administrator, and enter `Archisketch` in the search bar to install Archisketch plugin.
-2. After installing the plugin, enter the `Plugin key` in the plugin details page to activate it.
-    * You can check the `Plugin key` by entering the [connect] page in the Archisketch administrator page.
-    * Archisketch administrator is a `corporate service`. If you wish to use the administrator, please contact `Archisketch.Inc`.
+== How to Use ==  
+1. Go to `Add Plugins` in the WordPress administrator panel.  
+2. Search for `Archisketch` and install the plugin.  
+3. Activate the plugin by entering your `Plugin Key` in the settings page.  
+   - You can find the `Plugin Key` in the [Connect] section of the Archisketch administrator page.  
+   - Note: The Archisketch administrator is a corporate service. Contact Archisketch Inc. for access.  
 
-== External services ==
-This plugin allows enterprise users to integrate the Archisketch 3D Interior Platform into their websites.
-By doing so, website visitors can access a customized 3D interior design platform to explore 3D interiors and furniture content set up by the enterprise users.
+== Frequently Asked Questions ==  
 
-The Archisketch plugin provides APIs with the following functions to seamlessly synchronize user data between the website (or service) and the Archisketch platform:
-- For existing members: When logged into the website, users are automatically signed into the Archisketch platform integrated into the site.
-- For new members: When a new user signs up, their information is automatically synced with Archisketch.
+**Q: What is the purpose of this plugin?**  
+A: The Archisketch plugin integrates a 3D interior design platform into your website, allowing visitors to explore designs and furniture interactively.  
 
-This plugin connects to the Archisketch API and resources to provide its core functionalities. Below are the details of the external services used:
+**Q: Where can I find the Plugin Key?**  
+A: Log in to your Archisketch administrator account and navigate to the `Connect` section.  
 
-1. **Archisketch API**  
-   - **Domain**: `https://api.archisketch.com`  
-   - **Purpose**:  
-     - Synchronize user data between the WordPress website and the Archisketch platform.  
-     - Manage API requests such as verifying integration status and removing data connections.  
-   - **Data Transmitted**:  
-     - User identifier (UUID)  
-     - Encrypted data for verification (X-CONNECT-CHECK header)  
+**Q: Can individual users use this plugin?**  
+A: The plugin is primarily for businesses and requires access to the Archisketch administrator portal.  
 
-   **Endpoints Used**:  
-   - `https://api.archisketch.com/v1/connect/plugins?identifier={UUID}`  
-   - `https://api.archisketch.com/v1/connect/channels/{identifier}?type=wordpress`  
+== Screenshots ==  
 
-2. **Archisketch Resources**  
-   - **Domain**: `https://resources.archisketch.com`  
-   - **Purpose**:  
-     - Load the JavaScript files required for the Archisketch plugin's frontend functionality.  
-   - **Resources Loaded**:  
-     - `https://resources.archisketch.com/connect/wordpress-plugin.min.js`
+1. **Plugin Search and Installation**  
+   ![Screenshot 1](https://ps.w.org/archisketch-3d-interior-design-solution/assets/screenshot-1.png)  
+   *Find and install the Archisketch plugin in the WordPress plugin directory.*  
 
----
+2. **Plugin Key Input**  
+   ![Screenshot 2](https://ps.w.org/archisketch-3d-interior-design-solution/assets/screenshot-2.png)  
+   *Enter the Plugin Key to activate Archisketch features.*  
 
-This service is provided by Archisketch Inc.
-By using this plugin, user data is transmitted securely to Archisketch servers to enable integration and synchronization functionalities.
-For more details, refer to Archisketch's [Privacy Policy](https://www.archisketch.com/en/help-center/tutorial/privacy-policy--5e7304bf3313c904a38918cb#cate-1) and [Terms of Service](https://www.archisketch.com/en/help-center/tutorial/user-agreement--5e088b0eedfa5366bdc515bb#cate-1).
+3. **3D Interior View**  
+   ![Screenshot 3](https://ps.w.org/archisketch-3d-interior-design-solution/assets/screenshot-3.png)  
+   *Explore 3D interiors directly on your website.*  
 
-== Changelog ==
+== Upgrade Notice ==  
 
-= 1.0 =
-* Initialize
+**1.1.0**  
+- Updated to WordPress team feedback.  
+- Enhanced descriptions and added new features.  
 
-= 1.1 =
-* Review and fixed comments from WordPress Team.
+== Changelog ==  
+
+= 1.0 =  
+* Initial release.  
+
+= 1.1 =  
+* Added missing sections: FAQs, Screenshots, and Upgrade Notice.  
+* Removed underused tags (`interior`, `furniture`).  
+* Refined documentation.  
+
+== Donate ==  
+If you find this plugin helpful, consider supporting further development: [Donate Here](https://www.example.com/donate).