Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Commit

Permalink
Remove "type" from composer.json (#4)
Browse files Browse the repository at this point in the history
* Remove "type" from composer.json

* Update README.md

* Update composer.json
  • Loading branch information
jonginn authored Jan 25, 2017
1 parent c9c4372 commit e91e50b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 12 deletions.
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Important note for Craft CMS users
Because Composer doesn't let you install to a folder of your choice, at the current time we are hijacking the [composer/installers](https://github.com/composer/installers) package for 'Craft Plugins'. This means you must add an item to your composer.json to place it in a folder of your choice. This will only affect users who use Craft CMS.

# Info
This project is a collection of useful utilities, applicable to any web project. This includes Sass mixins.

Expand All @@ -15,23 +12,17 @@ Then include it in your composer:

And specify a version or minimum version.

As this repo is private on BitBucket, your development machine *and* your servers will need authorised keys on bitbucket to pull this repo.

# Configure where you want the package to go
In your `composer.json`, add the following:
If you want to install somewhere other than `vendor`, in your `composer.json` add the following:

```
"extra": {
"installer-paths": {
"wp-content/themes/timber/packages/{$name}": ["type:craft-plugin"]
"wp-content/themes/timber/packages/{$name}": ["wearebase/web-front-end-utilities"]
}
}
```

This plugin identifies itself as a `craft-plugin`. The addition above will send all `craft-plugin` to a directory you specify. I recommend to send it to your src directory in a third-party folder you can easily access with Sass, Twig, etc. If using Wordpress, send it to a theme/third-party directory and gitignore that folder.

If you do not specify this item in `composer.json` this utility will install to `craft/plugins/{$name}` as that is the default from `composer/installer` package.

# Enabling

## Sass
Expand Down
1 change: 0 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "wearebase/web-front-end-utilities",
"description": "Useful Front End Utilities",
"type": "craft-plugin",
"license": "MIT",
"require": {
"composer/installers": "^1.0"
Expand Down

0 comments on commit e91e50b

Please sign in to comment.