vim-dnsserial/README.md

vim-dnsserial
=============

[![Apache License 2.0](https://img.shields.io/github/license/breard-r/vim-dnsserial.svg "Apache License 2.0")](https://www.apache.org/licenses/LICENSE-2.0.html)

Another DNS-zone serial number updater.


Why?
----

I know this not the first vim plugin available to update a DNS-zone serial number. Here is a few reasons why I chose not to use the canonical one:

* there is no license and therefore it is not free;
* it is unmaintained;
* it is bugged;
* it lacks functionalities.

It chose not to fork the original plugin but to write a new one from scratch mainly for legal purposes, but also because I did not found the code as simple as I expected.


Usage
-----

By default, each time you save a `bindzone` file, the script will look for the DNS serial number and update it. You can also update it without saving the file by invoking the `:DNSSerialUpdate` function.


Configuration
-------------

You can turn off the automatic serial update by setting `let g:dnsserial_auto_update = 0` in your vimrc.
Initial commit. 2015-10-18 00:59:31 +02:00			`vim-dnsserial`
			`=============`

Add a badge with the license. Using such a badge allows the user to quickly identify the license. 2015-11-09 11:28:56 +01:00			`[![Apache License 2.0](https://img.shields.io/github/license/breard-r/vim-dnsserial.svg "Apache License 2.0")](https://www.apache.org/licenses/LICENSE-2.0.html)`

Initial commit. 2015-10-18 00:59:31 +02:00			`Another DNS-zone serial number updater.`
Add a "why?" section in the readme. Knowing why this plugin has been written may help users to use it instead of the old one. 2015-10-18 01:17:31 +02:00

			`Why?`
			`----`

			`I know this not the first vim plugin available to update a DNS-zone serial number. Here is a few reasons why I chose not to use the canonical one:`

			`* there is no license and therefore it is not free;`
			`* it is unmaintained;`
			`* it is bugged;`
			`* it lacks functionalities.`

			`It chose not to fork the original plugin but to write a new one from scratch mainly for legal purposes, but also because I did not found the code as simple as I expected.`
Add the possibility to turn off the automatic serial update. Some users may want to explicitly update the DNS serial number. Instead of forcing them to update on each write, a new configuration option is used so they can chose turn it off. 2015-11-14 19:05:12 +01:00

Add a `Usage` section in the README. Users shouldn't have to guess neither that the plugin auto-updates the DNS serial number nor the name of the function to call to manually update it. 2015-11-14 19:12:03 +01:00			`Usage`
			`-----`

			By default, each time you save a `bindzone` file, the script will look for the DNS serial number and update it. You can also update it without saving the file by invoking the `:DNSSerialUpdate` function.


Add the possibility to turn off the automatic serial update. Some users may want to explicitly update the DNS serial number. Instead of forcing them to update on each write, a new configuration option is used so they can chose turn it off. 2015-11-14 19:05:12 +01:00			`Configuration`
			`-------------`

			You can turn off the automatic serial update by setting `let g:dnsserial_auto_update = 0` in your vimrc.