Create CODE_OF_CONDUCT.md

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yashhanda7@yahoo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

README.md

@@ -8,12 +8,101 @@
 ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/Yash-Handa/logo-ls?sort=semver&style=flat-square)
 ![PRs](https://img.shields.io/badge/PRs-welcome-56cc14?style=flat-square)
 [![HitCount](http://hits.dwyl.com/{Yash-Handa}/{logo-ls}.svg)](http://hits.dwyl.com/{Yash-Handa}/{logo-ls})
+![deb](https://img.shields.io/badge/-Deb%20Package-A81D33?style=flat-square&logo=Debian&link=https://github.com/Yash-Handa/logo-ls/releases/)
+![rpm](https://img.shields.io/badge/-RPM%20Package-EE0000?style=flat-square&logo=Red-Hat&link=https://github.com/Yash-Handa/logo-ls/releases/)
+![linux](https://img.shields.io/badge/-Linux%20Binary-FCC624?style=flat-square&logo=Linux&logoColor=000000&link=https://github.com/Yash-Handa/logo-ls/releases/)
+![apple](https://img.shields.io/badge/-Darwin%20Binary-999999?style=flat-square&logo=Apple&logoColor=ffffff&link=https://github.com/Yash-Handa/logo-ls/releases/)
 
-modern ls command with vscode like file logos. Written in Golang
+modern ls command with beautiful Icons and Git Integrations . Written in Golang
 
 Command and Arguments supported are listed in [HELP.md](/HELP.md)
 
-## Check the downloaded Resource
+## Table of contents
+
+- [Features](#features)
+- [Usage](#usage)
+  - [Flags](#flags)
+    - `-1`
+    - `-a` (or) `--all`
+    - `-A` (or) `--almost-all`
+    - `-D` (or) `--git-status`
+    - `-l`, `-o`, `-g`, `-G`
+    - `-R` (or) `--recursive`
+    - `-?` (or) `--help`
+    - Sorting:
+      - `-t`, `-S`, `-X`, `-U`, `-v` and `-r` (`--reverse`)
+    - `-T` (or) `--time-style=value`
+    - `-i` (or) `--disable-icon`
+    - `-c` (or) `--disable-color`
+  - [Combination of flags](#combination-of-flags)
+  - [Multiple Files and Directories](#multiple-files-and-directories)
+- [Installation](#installation)
+- [Recommended configurations](#recommended-configurations)
+- [Updating](#updating)
+- [Uninstallation](#uninstallation)
+- [Icon Set](#icon-set)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+This project is build to add esthetics to ls(coreutiles) command
+
+- Over 250+ icons
+- Supporting 600+ files, extensions and directories
+- 16 Million, true colors supported
+- Git Status Integration
+- Near native speed. (thanks to Golang)
+- Language agnostic binaries
+
+This project is highly inspired by [ls(coreutiles)](https://www.gnu.org/software/coreutils/manual/html_node/ls-invocation.html#ls-invocation) and [color ls](https://github.com/athityakumar/colorls). The project tries to find a happy path between speed and aesthetics.
+
+## Usage
+
+All supported flags can be found by using help flag `$ logo-ls -?`. The same has been provided as [HELP.md](/HELP.md).
+
+The project also has its manpage which can be accessed by `man logo-ls`
+
+### Flags
+
+Almost all flags are same as that of the classic ls command and behave similarly. The project can be used as a drop-in replacement for the ls(coreutiles)
+
+- With `-1`: List one entry per line
+- With `-a` (or) `--all` : Does not ignore entries starting with '.'
+- With `-A` (or) `--almost-all` : Does not ignore entries starting with '.', except `./` and `../`
+- With `-D` (or) `--git-status`: Add Git Status to the listed Files and Directory
+  - *Note*: As much I would love to make this the default behavior of the command but showing git status is an intensive task and may slow (a tiny bit) the command itself. If you want you can make alias to the command with `-D` applied to it.
+- With `-l`: Shows in long listing format
+  other similar commands are:
+  - `-o`: like `-l`, but do not list group information
+  - `-g`: like `-l`, but do not list owner
+  - `-G` (or) `--no-group`: in a long listing, don't print group names
+- With `-R` (or) `--recursive`: list subdirectories recursively
+- With `-?` (or) `--help`: print the help message
+  - similar message can be found at [HELP.md](/HELP.md).
+- **Sorting**: There are many sorting flags available [default is *alphabetic order*]
+  - With `-t`: sort by modification time, newest first
+  - With `-S`: sort by file size, largest first
+  - With `-X`: sort alphabetically by entry extension
+  - With `-U`: do not sort; list entries in directory order
+  - With `-v`: natural sort of (version) numbers within text
+  - With `-r` (or) `-reverse`: reverse order while sorting
+- With `-T` (or) `--time-style=value`: set time/date format in long formats (`-l`, `-o`, `-g`). There are many options to chose from all are listed in [HELP.md](/HELP.md).
+- With `-i` (or) `--disable-icon`: don't print icons of the files
+- With `-c` (or) `--disable-color`: don't color icons, filenames and git status
+  - *Note*: use a combination of `-ic` to print output to a file `$ logo-ls -ic > t.txt`
+
+For all available commands see manpage or [HELP.md](/HELP.md)
+
+### Combination of flags
+
+This project uses [getopt](https://github.com/pborman/getopt) which is a golang variant of the classic getopt utility used in ls(coreutiles). Thus any combination of flags are possible and can be used.
+
+### Multiple Files and Directories
+
+You can provide multiple files and directories as command argument [default to PWD] and all will be displayed accordingly.
+
+### Check the downloaded Resource
 
 receive public key of the signing party
 
@@ -51,6 +140,12 @@ logo-ls_Linux_armv6.tar.gz: OK
 
 Note: The downloaded resources to verify and `logo-ls_SHA512sums.txt` should be in the same directory
 
+## Recommended configurations
+
+## Updating
+
+## Uninstallation
+
 ## Example Commands
 
 <div>
@@ -102,3 +197,7 @@ Note: The downloaded resources to verify and `logo-ls_SHA512sums.txt` should be
   <img alt="icons" title="Icon Set" src="/.github/images/icons.png">
     </span>
 </div><br>
+
+## Contributing
+
+## License