bookworms - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

docs/ADVANCED-USAGE.md

		# Advanced usage

		The top level [README](../README.md) shows the basic `get` functionality but there are more options and ways to see Bookworms.
		The top level [README](../README.md) shows the basic `get` functionality but there are more options and ways to use Bookworms.

		@@ -13,3 +13,3 @@ ## Get

		This will then generate in the `./` folder the different exports you can then use in your older tools.
		This will then generate in the `./` directory the different exports you can then use in your older tools.

		@@ -35,3 +35,3 @@ ```BASH

		In this example Bookworms is merging together multiple bookmark `YAML` files it will be default merge them into one top level folder called "Merged worms" but you can override the label and the description with the command:
		In this example Bookworms is merging together multiple bookmark `YAML` files, by default it will merge them into one top level folder called "Merged worms" but you can override the label and the description with the command:

		@@ -44,4 +44,7 @@ ```BASH

		`covert` works in a similar way to `get` with the same options.
		If you already have bookmarks in your browser you can speed up the process of converting them into `YAML` using the `convert` tool, read more about that here:
		[Exporting existing bookmarks](./docs/EXPORTING-EXISTING-BOOKMARKS.md).

		The `covert` command works in a similar way to `get` with the same options.

		```BASH
		@@ -48,0 +51,0 @@ $ npx convert ./browsers.html -d="./output"

docs/DEVELOPERS.md

		# Developers

		If you want to contribute or are interested in building something with bookworms here is how to get started.
		If you want to contribute or are interested in building something with Bookworms here is how to get started.

		@@ -5,0 +5,0 @@ ## Importing Bookworms modules

package.json

		{
		"name": "bookworms",
		"version": "1.2.0",
		"version": "1.2.1",
		"description": "A cli tool for centralising and generating bookmarks",
		@@ -5,0 +5,0 @@ "main": "./src/index.js",

README.md

		<p align="center">
		<a href="https://www.jamesbarryillustration.com/">
		<img width="25%" src="./docs/img/logo.png">
		<img width="50%" src="./docs/img/logo.png">
		</a>
		@@ -62,6 +62,6 @@ </p>
		```BASH
		npx bookworms get ./my-bookmarks.yaml
		$ npx bookworms get ./my-bookmarks.yaml
		```

		This will then generate in the `./` folder the different exports you can then use in your older tools.
		This will then generate in the `./` directory the different exports you can then use in your older tools.

		@@ -74,9 +74,9 @@ ```BASH

		You can also fetch bookmarks from a remote location:
		To fetch bookmarks from a remote location just use a standard `http` URL:

		```BASH
		npx bookworms get https://raw.githubusercontent.com/thearegee/bookworms/main/demo/config/bookmarks.yaml
		$ npx bookworms get https://raw.githubusercontent.com/thearegee/bookworms/main/demo/config/bookmarks.yaml
		```

		You can then import the `browsers.html` to display your bookmarks in your browser or the `readme.md` into your projects, for more information on how to use these files see [Using your bookmarks](./docs/USING-YOUR-BOOKMARKS.md) or if you want to see other options available to you see [Advanced usage](./docs/ADVANCED-USAGE.md).
		Now you can import the `browsers.html` to display your bookmarks in your browser or the `readme.md` into your projects, for more information on how to use these files see [Using your bookmarks](./docs/USING-YOUR-BOOKMARKS.md) or if you want to see other options available to you see [Advanced usage](./docs/ADVANCED-USAGE.md).

		@@ -88,3 +88,3 @@ ## Help
		```Bash
		npx bookworms --help
		$ npx bookworms --help
		```
		@@ -102,3 +102,3 @@
		- Test `convert` with browsers other than Chrome
		- Bug fix markdown generator header folder depth
		- Bug fix markdown generator header for deep folders
		- Improve documentation for using bookworms modules
		@@ -112,5 +112,5 @@ - Allow users to select the exports they want or won't want
		- Remove step for people to need to import files in browser
		- Add the idea of public bookmarks which could genate trends
		- Make a chrome extension that could load remote YAML files
		- Rewrite in TS
		- Add the idea of public bookmarks which could generate trends
		- Investigate a chrome extension that could load remote YAML files
		- Document Murphy Slackbot that uses Bookworms

		@@ -117,0 +117,0 @@ ## Credits

bookworms - npm Package Compare versions

Improved metrics