docximager - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

index.js

@@ -54,3 +54,3 @@
             res.on('end', ()=>{
-                fs.writeFileSync('t1.png', );
+                fs.writeFileSync('t1.'+type, );
                 this.__replaceImage(Buffer.concat(buffer), image_id, type, cbk);
@@ -57,0 +57,0 @@ });

package.json

 {
   "name": "docximager",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Tool to include images in docx.",
@@ -5,0 +5,0 @@ "author": "Varun2604",

README.md

@@ -0,19 +1,63 @@
+# DOCX IMAGER
+
 A simple package with which you can dynamically insert images to your docx.
 
+## Getting Started
+
+```
+npm i docximager --save
+```
+
+## What can Docx Imager do for you ?
+
+
+## How to insert your images dynamically ?
+
 Just follow these simple steps:
 
 1. Include the package.
+   ```
    const DocxImager = require('DocxImager');
+   ```
    
 2. Create a new Instance of DocxImager.
-   let dImager = new DocxImager();
+   ```
+   let docxImager = new DocxImager();
+   ```
    
 3. Load your docx file.
-   await dImager.load('./my.docx')
+   ```
+   await docxImager.load('./my.docx')
+   ```
    
 4. Insert or replace your image
-   await dImager.replaceWithImageURL('https://path_of_inage.com/image.png')
+   ```
+   await docxImager.replaceWithImageURL('https://path_of_inage.com/image.png')
+   ```
    
 5. Save your new document in the specified path.
-   await dImager.save('./my_new_docx.docx');
+   ```
+   await docxImager.save('./my_new_docx.docx');
+   ```
+
+## Built With
+
+* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
+* [Maven](https://maven.apache.org/) - Dependency Management
+* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
+
+## Contributing
+
+Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Authors
+
+* **Varun Venketeswaran Iyer** - *Initial work* - [Varun2604](https://github.com/Varun2604)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+
+
     

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

534830

increased by1.18%

Number of lines in readme file

63

increased by231.58%

No dependency changes