Skip to content

Commit

Permalink
Merge branch 'mindplay-dk-patch-1'
Browse files Browse the repository at this point in the history
  • Loading branch information
francoispluchino committed Apr 10, 2019
2 parents 1dc8aa1 + 87caf30 commit bfaa163
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions Resources/doc/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
Get starting
============

1. [Required dependencies](index.md#required-dependencies)
2. [Installation](index.md#installation)
3. [Usage](usage.md)
4. [Configuration](config.md)
5. [Event](events.md)
6. [FAQs](faqs.md)
Getting started
===============

1. [Introduction](index.md#introduction)
2. [Required dependencies](index.md#required-dependencies)
3. [Installation](index.md#installation)
4. [Usage](usage.md)
5. [Configuration](config.md)
6. [Event](events.md)
7. [FAQs](faqs.md)

## Introduction

Foxy is a Composer plug-in that aggregates npm-packages from Composer packages.

This makes it possible (and automates the process of) installing and updating npm-packages that ship with your Composer packages, leveraging the native (`npm` or `yarn`) package manager to do the heavy lifting.

For this approach to work well, you should think of an npm-package in a Composer package not just as an "artifact", but as an actual npm-package *embedded* in your Composer package.

Importantly, you should name it and *version* it, independently of your Composer version number - like you would normally do with a stand-alone npm-package.

Note that, for npm-packages with no version number, Foxy will default to the Composer version, as a fallback only: versioning your npm-package explicitly is much safer in terms of correctly versioning breaking/non-breaking changes to any client-side APIs exposed by the embedded npm-package.

## Required dependencies

Expand Down

0 comments on commit bfaa163

Please sign in to comment.