From b78c134bd743eebfd51cdcf84f7038ba0bd0053e Mon Sep 17 00:00:00 2001 From: BrandonRomano Date: Sun, 14 Feb 2016 13:27:21 -0500 Subject: [PATCH] Clean README, remove all references to ash core --- LICENSE.md | 2 +- README.md | 37 ++++++++++++++++--------------------- 2 files changed, 17 insertions(+), 22 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 6a81c89..5c20fa5 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2015 Brandon Romano +Copyright (c) 2016 Brandon Romano Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 65d6904..12a1e10 100644 --- a/README.md +++ b/README.md @@ -4,40 +4,39 @@ Slugify is an [Ash](https://github.com/ash-shell/ash) module that allows you to ## Getting started -### Ash Users +You're going to have to install [Ash](https://github.com/ash-shell/ash) to use this module. -Slugify is part of the Ash core, so you won't need to install it. +After you have Ash installed, run either one of these two commands depending on your git clone preference: -You can either call Slugify straight from the command line, or as an imported library. +- `ash apm:install https://github.com/ash-shell/slugify.git` +- `ash apm:install git@github.com:ash-shell/slugify.git` -#### Command Line Usage +You can optionally install this globally by adding `--global` to the end of the command. -```sh -ash slugify "Some, String" -``` +## Usage -Will output: +You can either call Slugify straight from the command line, or as an imported library. -```sh -<< Slugify >>: some-string -``` +### Command Line Usage -#### Module Usage +Check out the [HELP.txt](HELP.txt) file for command line usage. You can also run `ash slugify:help` in the terminal. -Even though Slugify is part of the Ash core, you will still need to import it into your modules. +### Imported Library Usage -Add this line to the top of any file called from Ash: +Before you can use Slugify in your modules, you must import it: ```bash -Ash__import "slugify" +Ash__import "github.com/ash-shell/slugify" ``` After including this library, you are free to start using it. -The main function that you'll want to use is `Slugify__slugify`. Here is some example usage: +##### Slugify__slugify + +The main function available in this library is `Slugify__slugify`. Here is some example usage: ```sh -slug="$(Slugify__slugify "Some, String")" +slug="$(Slugify__slugify "Some String")" echo "$slug" ``` @@ -47,10 +46,6 @@ Will output: some-string ``` -### Non Ash Users - -Follow the same usage as described in "Module Usage", but instead of using `Ash__import "slugify"` use `. {path_to_slugify}/lib/slugify.sh`. - ## License [MIT](LICENSE.md)