Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 9, 2020
1 parent 0a1986f commit 0b9f4ee
Show file tree
Hide file tree
Showing 4 changed files with 157 additions and 58 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ node_modules
*.env
.DS_Store
package-lock.json
.bloggify/*
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2015-19 Ionică Bizău <[email protected]> (https://ionicabizau.net)
Copyright (c) 2015-20 Ionică Bizău <[email protected]> (https://ionicabizau.net)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
210 changes: 154 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,52 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


















# abs

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/abs.svg)](https://www.npmjs.com/package/abs) [![Downloads](https://img.shields.io/npm/dt/abs.svg)](https://www.npmjs.com/package/abs) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>







> A library to convert a path into an absolute path.
















## :cloud: Installation

```sh
Expand All @@ -20,6 +58,17 @@ yarn add abs
```













## :clipboard: Example


Expand All @@ -39,17 +88,28 @@ console.log(abs("~/foo"));











## :question: Get Help

There are few ways to get help:



1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:





## :memo: Documentation


Expand All @@ -65,12 +125,22 @@ Computes the absolute path of an input.














## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].


## :sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).

Expand All @@ -89,74 +159,102 @@ However, if you get some profit from this or just want to encourage me to contin
Thanks! :heart:
















## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

- `gry`
- `package-json-path`
- `write-file-p`
- `maybe-require`
- `fwatcher`
- `read-file-cache`
- `ethers-cli`
- `engine-paths`
- `git-repos`
- `bible.js`
- `git-stats`
- `rucksack`
- `statique`
- `engine-tools`
- `git-command`
- `ghcal`
- `packy`
- `np-init`
- `namy`
- `web-term`
- `blah`
- `auto-geo-sunset`
- `pm2-meteor-nvm`
- `bloggify-paths`
- `bible`
- `engine-app`
- `gh-notifier`
- `pm2-meteor-args`
- `cli-sunset`
- `emojer-cli`
- `github-labeller`
- `image-to-ascii-cli`
- `idea`
- `parrot-bot`
- `mdy`
- `mongof`
- `messager`
- `tithe`
- `ssh-remote`
- `rucksack.js`
- `tester-init`
- `tilda-init`
- `cdnjs-importer`
- `pm2-meteor`
- `simplywatch`
- `@isysd/gpm`
- `gpm`
- `extendscript-bundlr`
- `ship-release`
- `3abn`
- `git-issues`










- [`3abn`](https://github.com/IonicaBizau/3abn#readme)—A 3ABN radio client in the terminal.
- [`auto-geo-sunset`](https://github.com/aminnaggar/auto-geo-sunset#readme) (by Amin El-Naggar)—Automagically figures out your location using your ip, and uses that to calculate the time of sunset.
- [`bible`](https://github.com/BibleJS/BibleApp)—Read the Holy Bible via the command line.
- [`blah`](https://github.com/IonicaBizau/blah)—A command line tool to optimize the repetitive actions.
- [`bloggify-paths`](https://github.com/IonicaBizau/bloggify-paths#readme)—Helper library for maintaining the Bloggify paths in one place.
- [`cdnjs-importer`](https://github.com/cdnjs/cdnjs-importer)—Easy way to import a library into CDNJS.
- [`cli-sunset`](https://github.com/IonicaBizau/cli-sunset)—A fancy command line tool for knowing the sunset time.
- [`emojer-cli`](https://github.com/IonicaBizau/emojer-cli#readme)—Command line tool for emojer.
- [`engine-app`](https://github.com/jillix/engine-app#readme) (by jillix)—Engine app related helper functions.
- [`engine-paths`](https://github.com/jillix/engine-paths#readme) (by jillix)—Keeping the Engine paths in one place.
- [`engine-tools`](https://github.com/jillix/engine-tools) (by jillix)—Engine Tools library and CLI app.
- [`ethers-cli`](https://npmjs.com/package/ethers-cli) (by Richard Moore)—Command-Line Interface to ethers.io and ethers.space.
- [`extendscript-bundlr`](https://github.com/fabiantheblind/extendscript-bundlr#readme)—a tool for bundling Adobe ExtendScripts that use the `#include 'path/to/file'` statement
- [`fwatcher`](https://github.com/IonicaBizau/node-fwatcher)—Watch files for changes.
- [`gh-notifier`](https://bitbucket.org/IonicaBizau/gh-notifier#readme)—Receive desktop notifications from your GitHub dashboard.
- [`ghcal`](https://github.com/IonicaBizau/ghcal)—See the GitHub contributions calendar of a user in the command line.
- [`git-command`](https://github.com/liangshuai/node-git#readme) (by ShuaiLiang)—Execute git command using Node.js
- [`git-issues`](https://github.com/softwarescales/git-issues) (by Gabriel Petrovay)—Git issues extension to list issues of a Git project
- [`git-repos`](https://github.com/IonicaBizau/node-git-repos#readme)—Find all the git repositories in a specified directory, recursively.
- [`git-stats`](https://github.com/IonicaBizau/git-stats)—Local git statistics including GitHub-like contributions calendars.
- [`github-labeller`](https://github.com/IonicaBizau/github-labeller#readme)—Automagically create issue labels in your GitHub projects.
- [`gpm`](https://github.com/IonicaBizau/gpm)—npm + git = gpm - Install NPM packages and dependencies from git repositories.
- [`gry`](https://github.com/IonicaBizau/node-gry)—A minimalist NodeJS wrapper for the `git` commands. `gry` stands for the Git RepositorY.
- [`idea`](https://github.com/IonicaBizau/idea)—A lightweight CLI tool and module for keeping ideas in a safe place quick and easy.
- [`image-to-ascii-cli`](https://github.com/IonicaBizau/image-to-ascii-cli#readme)—View images in text format, in your terminal.
- [`maybe-require`](https://github.com/IonicaBizau/maybe-require#readme)—A less violent require.
- [`mdy`](https://github.com/IonicaBizau/mdy#readme)—View markdown files in the command line with ANSI styled images.
- [`messager`](https://github.com/IonicaBizau/node-messager#readme)—Inter-process communication made simple.
- [`mongof`](https://github.com/IonicaBizau/node-mongof)—Sync MongoDB collections with JSON files.
- [`namy`](https://github.com/IonicaBizau/namy)—Gets the name of the exported function.
- [`np-init`](https://github.com/IonicaBizau/np-init#readme)—Easily start a npm package from scratch.
- [`package-json-path`](https://github.com/IonicaBizau/package-json-path#readme)—Get the package.json path in a specific directory.
- [`packy`](https://github.com/IonicaBizau/packy#readme)—Set default fields in your package.json files.
- [`parrot-bot`](https://github.com/IonicaBizau/parrot-bot#readme)—A parrot-like bot you can talk with.
- [`pm2-meteor`](https://github.com/andruschka/pm2-meteor) (by andruschka)—Simplest way to deploy, scale and run Meteor Apps with PM2.
- [`pm2-meteor-args`](https://github.com/andruschka/pm2-meteor) (by andruschka)—Simplest way to deploy, scale and run Meteor Apps with PM2.
- [`pm2-meteor-nvm`](https://github.com/andruschka/pm2-meteor) (by andruschka)—Simplest way to deploy, scale and run Meteor Apps with PM2.
- [`read-file-cache`](https://github.com/IonicaBizau/read-file-cache#readme)—Read files and cache them.
- [`rucksack`](https://github.com/Bloggify/rucksack#readme) (by Bloggify)—JavaScript and CSS bundler.
- [`ship-release`](https://github.com/IonicaBizau/ship-release#readme)—Publish new versions on GitHub and npm with ease.
- [`simplywatch`](https://github.com/danielkalen/simplywatch#readme) (by danielkalen)—Watches files and upon change executes a command for each file INDIVIDUALLY with file-related params
- [`ssh-remote`](https://github.com/IonicaBizau/ssh-remote)—Automagically switch on the SSH remote url in a Git repository.
- [`statique`](https://github.com/IonicaBizau/statique)—A Node.JS static server module with built-in cache options and route features.
- [`tester-init`](https://github.com/IonicaBizau/tester-init#readme)—Init tests for tester.
- [`tilda-init`](https://github.com/IonicaBizau/tilda-init#readme)—Init cli applications.
- [`tithe`](https://github.com/IonicaBizau/tithe)—Organize and track the tithe payments.
- [`web-term`](https://github.com/IonicaBizau/web-term)—A full screen terminal in your browser.
- [`write-file-p`](https://github.com/IonicaBizau/write-file-p#readme)—Create the directory structure and then create the file.

## :scroll: License

[MIT][license] © [Ionică Bizău][website]






[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg

[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW

[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@
"bloggify.json",
"bloggify/"
]
}
}

0 comments on commit 0b9f4ee

Please sign in to comment.