Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #69

Merged
merged 1 commit into from
Dec 25, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ Generates module specific .classpath files based on the Maven pom files in your
- The notification which informs you that a dependency doesn't exist always points to line 0.

## Configuration
Due to the changes I've made for V2, no configuration is required for this plugin. It relies on the fact that you have configured Maven correctly on your own system and piggybacks on top of that.
Currently no configuration is required for this package. Please ensure that Apache Maven is correctly installed on your computer and is ready to use on the command line.

## What's new in V2
Writing this package has been a huge learning experience for me, its basically my first major javascript / node js project and as such I made it unnecessarily complicated the first time round.
Please see the Maven website for [installation instructions](http://maven.apache.org/install.html).

At the core of V2, the major change that has been made is that I'm no longer trying to write an api to replicate what Maven does, but rather I actually use Maven! Obviously this means I've deleted a lot of code, improved the code quality immensely and gotten a lot of the features I wanted to write completely for free.
## What's new in version 1.0.0
The atom-maven package is a lot lazier in the new release, relying on your Maven installation to do all the hard work, rather than trying to replicate everything that Maven does. In doing this, a lot of the features I wanted to implement I got for free.

That being said, this project still has a handful of features I still want to implement so stay tuned!
Checkout the [changelog](https://github.com/concon121/atom-maven/blob/master/CHANGELOG.md) for the full list of recently implemented features and bug fixes.

## Backlog and Issues
The complete list of features which needs to be implemented, future enhancements, known issues and bugs can be found on the GitHub repository [here](https://github.com/concon121/atom-maven/issues).
The complete list of features which needs to be implemented, future enhancements, known issues and bugs can be found on the atom-maven GitHub repository [issues page](https://github.com/concon121/atom-maven/issues).

## Contributing
Contributions are always welcome, there is still a lot of work to be done! Feel free to pick up an issue in the backlog and open a pull request to get the conversation going. I am more than happy to provide help and direction, and very welcoming of advice and suggestions.
Expand Down Expand Up @@ -73,5 +73,6 @@ Capable of reading the generated .classpath file, this package will attempt to c
## Kudos
Kudos to the following, for making my life easier!

* [node-maven-api](https://www.npmjs.com/package/node-maven-api)
* [atom-message-panel](https://github.com/tcarlsen/atom-message-panel)
* [xml2js](https://github.com/Leonidas-from-XIV/node-xml2js)
95 changes: 47 additions & 48 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,50 +1,49 @@
{
"name": "atom-maven",
"main": "./lib/atom-maven",
"version": "1.0.0",
"description": "Maven integration for atom!",
"keywords": [
"apache",
"maven",
"java"
],
"repository": "https://github.com/concon121/atom-maven",
"license": "MIT",
"engines": {
"atom": ">=1.0.0 <2.0.0"
},
"dependencies": {
"atom-message-panel": "^1.2.4",
"jquery": "^3.0.0",
"node-maven-api": "^1.1.0",
"underscore": "^1.8.3",
"xml2js": "^0.4.16"
},
"devDependencies": {
"babel": "^6.5.2",
"babel-cli": "^6.9.0",
"babel-core": "^6.3.17",
"babel-preset-es2015": "^6.3.13",
"babel-register": "^6.9.0",
"codeclimate-test-reporter": "^0.3.1",
"happiness": "^6.0.7",
"istanbul": "^1.0.0-alpha.2",
"jasmine-focused": "^1.0.7",
"jshint": "^2.9.2"
},
"scripts": {
"test": "node ./node_modules/jasmine-focused/bin/jasmine-focused spec",
"coverage": "node ./node_modules/istanbul/lib/cli.js cover -v --include-all-sources -x **/atom/** node_modules/jasmine-focused/bin/jasmine-focused -R spec",
"quality": "node ./node_modules/jshint/bin/jshint lib/atom-maven.js lib/common.js lib/file-utils.js lib/maven-utils.js lib/pom-factory.js lib/pom-registry.js lib/pom.js lib/ui-utils.js lib/workspace.js"
},
"standard": {
"globals": [
"atom",
"it",
"spyOn",
"describe",
"expect",
"beforeEach"
]
}
"name": "atom-maven",
"main": "./lib/atom-maven",
"version": "1.0.0",
"description": "Maven integration for atom!",
"keywords": [
"apache",
"maven",
"java"
],
"repository": "https://github.com/concon121/atom-maven",
"license": "MIT",
"engines": {
"atom": ">=1.0.0 <2.0.0"
},
"dependencies": {
"atom-message-panel": "^1.2.4",
"jquery": "^3.0.0",
"node-maven-api": "^1.1.0",
"xml2js": "^0.4.16"
},
"devDependencies": {
"babel": "^6.5.2",
"babel-cli": "^6.9.0",
"babel-core": "^6.3.17",
"babel-preset-es2015": "^6.3.13",
"babel-register": "^6.9.0",
"codeclimate-test-reporter": "^0.3.1",
"happiness": "^6.0.7",
"istanbul": "^1.0.0-alpha.2",
"jasmine-focused": "^1.0.7",
"jshint": "^2.9.2"
},
"scripts": {
"test": "node ./node_modules/jasmine-focused/bin/jasmine-focused spec",
"coverage": "node ./node_modules/istanbul/lib/cli.js cover -v --include-all-sources -x **/atom/** node_modules/jasmine-focused/bin/jasmine-focused -R spec",
"quality": "node ./node_modules/jshint/bin/jshint lib/atom-maven.js lib/common.js lib/file-utils.js lib/maven-utils.js lib/pom-factory.js lib/pom-registry.js lib/pom.js lib/ui-utils.js lib/workspace.js"
},
"standard": {
"globals": [
"atom",
"it",
"spyOn",
"describe",
"expect",
"beforeEach"
]
}
}