Mateusz Piotrowski
2a66ec2e5e
Add FreeBSD installation instructions
2019-03-21 18:40:28 +01:00
Justin Foreman
e4e99f0aba
docs: Update README for CentOS dependency
2018-05-31 11:06:22 +02:00
Adrien Vergé
203cfc20f0
docs: Remove sudo from pip installation instructions
2018-05-09 20:20:18 +02:00
Adrien Vergé
51c30505b5
docs: Add Mac OS installation instructions
...
See https://github.com/adrienverge/yamllint/issues/91 and
https://github.com/Homebrew/homebrew-core/blob/af2bbe9/Formula/yamllint.rb
2018-05-09 20:19:03 +02:00
Adrien Vergé
df26cc0438
feat(config): Add support to ignore paths on per-rule basis
...
Example of configuration to use this feature:
# For all rules
ignore: |
*.dont-lint-me.yaml
/bin/
!/bin/*.lint-me-anyway.yaml
rules:
key-duplicates:
ignore: |
generated
*.template.yaml
trailing-spaces:
ignore: |
*.ignore-trailing-spaces.yaml
/ascii-art/*
Closes #43 .
2017-06-28 15:14:46 +02:00
Adrien Vergé
2b7f5c5e72
docs(install): Update Debian version
...
yamllint is now backported in Debian 8 (Jessie):
https://tracker.debian.org/pkg/yamllint
https://packages.debian.org/source/jessie-backports/yamllint
2016-11-16 18:50:13 +01:00
Adam Chainz
d7c17c7e7c
Doc: Convert readthedocs links from .org to .io
...
As per [their blog post of the 27th
April](https://blog.readthedocs.com/securing-subdomains/ ) ‘Securing
subdomains’:
> Starting today, Read the Docs will start hosting projects from
> subdomains on the domain readthedocs.io, instead of on
> readthedocs.org. This change addresses some security concerns around
> site cookies while hosting user generated data on the same domain as
> our dashboard.
Test Plan: Manually visited all the links I’ve modified.
2016-09-21 10:36:00 +02:00
Adrien Vergé
09118e417c
Doc: Add license information on README page
2016-06-27 21:32:55 +02:00
Adrien Vergé
71b90ae208
Doc: Add new features in README
2016-06-27 21:32:55 +02:00
Adrien Vergé
8844855353
Doc: Remove old Debian install commands from README
2016-06-27 21:15:55 +02:00
Adrien Vergé
eabd349902
Config: Allow a user-global configuration file
...
Instead of just looking for `.yamllint` in the current working
directory, also look for `~/.config/yamllint/config` (using
`$XDG_CONFIG_HOME` or `$HOME`, see [1] and [2] for information).
[1]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-0.6.html
[2]: https://wiki.archlinux.org/index.php/XDG_Base_Directory_support
Closes : #6
2016-04-21 22:24:24 +02:00
Adrien Vergé
a483524b63
Doc: Update installing section
...
Packages are now also available in Debian and Ubuntu.
2016-03-15 10:04:24 +01:00
Adrien Vergé
41733fc7a5
Use '.yaml' extension as default, not '.yml'
...
As someone said [1] on the internet:
Say ".yaml" not ".yml".
This is not MS-DOS, and YML is a Yahoo XML dialect.
Similarly, we use '.json', not '.jsn'.
[1]: https://github.com/ceph/s3-tests/commit/e17c56a
2016-03-07 11:15:04 +01:00
Adrien Vergé
688858e639
Doc: Reference Fedora and Ubuntu packages
2016-03-07 11:05:29 +01:00
Adrien Vergé
7688567faa
cli: Add the -d option to provide inline conf
2016-03-04 16:53:26 +01:00
Adrien Vergé
2f75e92a66
Doc: Add a configuration example in README
2016-02-19 10:37:52 +01:00
Adrien Vergé
0e04ee29e6
Doc: Update description
2016-02-01 23:03:25 +01:00
Adrien Vergé
376a6ed484
Doc: Enhance short description
2016-01-24 18:40:48 +01:00
Adrien Vergé
45538fb08a
Doc: Explicit installation by adding sudo in README
2016-01-24 18:05:27 +01:00
Adrien Vergé
7983c66093
Doc: Clarify Python compatibility in README
2016-01-23 14:32:02 +01:00
Adrien Vergé
fee72d484e
Doc: Add a screenshot
2016-01-23 14:30:24 +01:00
Adrien Vergé
26b5364be4
Doc: Add Read The Docs status badge in README
2016-01-22 18:20:31 +01:00
Adrien Vergé
48589176c7
Doc: Convert README.md to README.rst
2016-01-22 18:20:31 +01:00
