diff --git a/packages/xml-to-mongodb-importer/README.md b/packages/xml-to-mongodb-importer/README.md index 9caa5dd9..c2c2ecc2 100755 --- a/packages/xml-to-mongodb-importer/README.md +++ b/packages/xml-to-mongodb-importer/README.md @@ -6,7 +6,7 @@ - Splits large XML files into smaller chunks. - Imports XML data into MongoDB. -- Automatically cleans up temporary files. +- Automatically cleans up chunks files. ## Installation @@ -46,15 +46,17 @@ runImporter(params) ### Parameters -- `xmlUrl` (string): The path to your XML file. It must end with `.xml`. -- `openingTag` (string): The opening tag of the XML elements to be split. It must be enclosed in angle brackets, e.g., ``. -- `closingTag` (string): The closing tag of the XML elements to be split. It must be enclosed in angle brackets, e.g., ``. -- `connection` (object): An object containing the MongoDB connection details: - - `mongoURI` (string): The MongoDB connection URI. - - `databaseName` (string): The name of the database. - - `collectionName` (string): The name of the collection. -- `chunkSize` (number, optional): The number of XML elements per chunk. Default is 2500. +| Parameter | Type | Description | +|------------------|----------|-----------------------------------------------------------------------------------------------| +| `xmlUrl` | string | The path to your XML file. It must end with `.xml`. | +| `openingTag` | string | The opening tag of the XML elements to be split, enclosed in angle brackets (e.g., ``). | +| `closingTag` | string | The closing tag of the XML elements to be split, enclosed in angle brackets (e.g., ``). | +| `connection` | object | An object containing MongoDB connection details: | +| `connection.mongoURI` | string | The MongoDB connection URI. | +| `connection.databaseName` | string | The name of the MongoDB database where data will be imported. | +| `connection.collectionName` | string | The name of the MongoDB collection where data will be imported. | +| `chunkSize` | number | (Optional) The number of XML elements per chunk. Default is 2500. | ### Contributing -If you find any issues or have suggestions for improvement, feel free to open an issue or submit a pull request on [GitHub](https://github.com/mernjs/create-mern-app/issues). +If you find any issues or have suggestions for improvement, feel free to open an issue or submit a pull request on [GitHub](https://github.com/mernjs/create-mern-app/issues). \ No newline at end of file diff --git a/packages/xml-to-mongodb-importer/package.json b/packages/xml-to-mongodb-importer/package.json index e8c13fa1..c96869ba 100755 --- a/packages/xml-to-mongodb-importer/package.json +++ b/packages/xml-to-mongodb-importer/package.json @@ -1,6 +1,6 @@ { "name": "xml-to-mongodb-importer", - "version": "1.0.4", + "version": "1.0.5", "main": "index.js", "scripts": { "example": "cd example && yarn dev",