Commit graph

114 commits

Author SHA1 Message Date
Pavel Djundik
2bcb9bcca1 Update readme to suggest using yarn 2018-02-20 11:28:14 +02:00
Jérémie Astori
ca8df65dfd
Link npm version to the package page on Yarn 2018-02-19 13:21:06 -05:00
Jérémie Astori
bdb6064c76
Add logo to README, and make intro it look a little nicer 2018-02-19 13:21:06 -05:00
Jérémie Astori
8403d277b4
Replace reference to website with new URL 2018-02-19 12:23:41 -05:00
Jérémie Astori
aca23257ed
Switch CLI tool from lounge to thelounge and deprecate lounge
This is in preparation of The Lounge v3 which will make `thelounge` uniform across the entire project. No more confusion!
2017-11-22 16:37:26 -05:00
Pavel Djundik
0ac3ba28e1 Web Push Notifications 2017-08-22 10:54:18 +03:00
Pavel Djundik
533fe25db4
Add feature overview in readme 2017-08-17 23:14:27 -04:00
Al McKinlay
d839a9e64a Merge pull request #1319 from MaxLeiter/patch-1
Update README for when to run `npm run build`
2017-07-20 08:56:26 +01:00
Max Leiter
e0d6e11d4c Update README directions on when to npm run build
need to `npm run build` a lot more since webpack was added
2017-07-19 22:28:02 -07:00
Max Leiter
2fdd4ab16e Update README badge to new demo URL 2017-07-17 15:17:01 -07:00
Max Leiter
0b68b07e3b Update screenshot in README 2017-07-12 15:47:13 -07:00
Jérémie Astori
5d65f447b5 Remove devDependencies badge on README
Now that Greenkeeper is taking care of our dependencies, it makes less sense to keep this one.

This also create some room for a potential future extra badge if we need it, without taking up a new line.

I would however definitely keep the production dependencies badge because it informs users on the status of what they install. It also leaves an access to David's devDependencies report if interested.
2017-06-24 15:01:07 -04:00
drkitty
41b7e0e077 Explain about lounge command in dev installations 2017-01-24 01:04:40 -08:00
Jérémie Astori
552fa3fae8 Make and document npm run build now a mandatory step of the install/build setup
This has several reasons, benefits and consequences:

- When running on root (which is not recommended anyway), `npm run build` was already necessary.
- This allows to not use the `prepublish` hook, whose behavior is going to change in npm v5 and again in npm v6.
- This allows to create both production and development builds when running from source.
- It makes `npm run build` compatible with Windows again for development environments (lost in previous commit).
- It uses the `prepublishOnly` hook added in npm v4. Since this hook is not available prior to that, deployment to npm from Travis has to be done on the Node.js v7 environment.
2017-01-23 01:15:50 -05:00
Jérémie Astori
485fab6cd4 Simplify introduction on README
Features listed here are the same as on Shout repo, in same order, participating to the feeling of fork with nothing new. Instead of listing features here, we should refer to the website and improve it to make it as current as possible (there was some recent action there, and more coming, so it is reasonable to point there).

Also, this "Why the fork?" section was useful right when we forked, but now it gives unnecessary and lengthy information (it is now the most verbose section of the README!). The Lounge has enough momentum as that point to be treated as its own project.

Finally, shortening this section moves the screenshot back up on the page, and mobile view now has more context in the description.
2016-12-11 04:14:17 -05:00
Jérémie Astori
bafe23b4b7 Fix wrong order between screenshot and badges on README
Branch was not exactly up-to-date with `master` when merged, and badges were moved below the title in #713, so we missed that at review time.
2016-12-11 03:57:43 -05:00
Jérémie Astori
085ede43df Merge pull request #694 from MaxLeiter/MaxLeiter-image
Add image to readme
2016-12-09 00:44:27 -05:00
Jérémie Astori
0d54879e45 Warn against running from source as root in README 2016-11-27 16:37:47 -05:00
Max Leiter
9dd8a794e0 Update link 2016-11-14 19:27:11 -08:00
Pavel Djundik
3231097e0d Reduce badge size in readme 2016-10-23 00:39:22 +03:00
Max Leiter
b503b8cb4f Add image to readme 2016-10-15 13:48:26 -07:00
Jérémie Astori
7858504c4c Fix devDependency URL in David badge
Because they **needed** to break backward compatibility, didn't they...
2016-09-27 01:24:47 -04:00
Jérémie Astori
ae2b27ba5f Remove license info from the README
This is already on the badge and at the top of the page, on GitHub UI, as well as in 2 places in npm.
2016-09-20 23:00:42 -04:00
Jérémie Astori
f1c3e376c5 Add information on running from source and clean up README a bit 2016-09-20 23:00:42 -04:00
Max Leiter
727e7deb5e Mention wiki in README 2016-08-26 09:16:01 -07:00
Jérémie Astori
55c483b41f Add an AppVeyor badge on the README 2016-05-31 04:42:35 -04:00
Pavel Djundik
96f8cd9a28 Dot is not part of the path 2016-05-08 12:36:18 +03:00
Max Leiter
2b2d9dac6c Updates demo link to HTTPS 2016-05-07 15:26:54 -07:00
Pavel Djundik
f2be46474a Change license link to point at our license file 2016-04-29 13:42:04 +03:00
Pavel Djundik
d428bb7511 Document supported node version 2016-04-27 10:07:43 +03:00
Hendrik Leppelsack
90e4592e31 link to lounge demo from irc badge 2016-03-17 15:46:29 +01:00
Alexis Métaireau
bb35aca032 Added a section explaining why a fork was created. 2016-02-27 17:56:24 +01:00
Jérémie Astori
fe6da75854 Remove compiled assets and generate them at prepublish time
- Remove minified libs and compiled templates
- Add a `prepublish` script to build assets, that run on `npm install`
  and right before publishing
  See https://docs.npmjs.com/misc/scripts
- Include these compiled assets to the `.gitignore` file
- Add an empty .npmignore to make sure the compiled assets are not
  ignored when publishing
  https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package
- Update the README to reflect changes in development

Note that the Travis CI configuration does not need any tweaking
because it cleans up all extra and changed files, up to publishing on
npm. That is, right before `prepublish` gets run.
See https://docs.travis-ci.com/user/deployment/npm#Releasing-build-artifacts
2016-02-18 06:01:37 +00:00
Jérémie Astori
435998a211 Add mention to credit @erming's great work and inheritance from Shout 2016-02-10 07:47:01 +00:00
Jérémie Astori
447e8c7ad5 Update the project name
Also remove link to the demo and use HTTPS to the docs
2016-02-10 04:30:05 +00:00
Jérémie Astori
263d1d5c78 Add a badge to display the IRC channel at the top 2016-01-22 06:33:09 +00:00
Jérémie Astori
2f5b1663d7 Merge pull request #465 from astorije/astorije/badges
Badges badges badges
2016-01-10 18:47:24 -05:00
Jérémie Astori
a5316ae12c Trim trailing whitespaces in README 2016-01-10 23:45:14 +00:00
Jérémie Astori
bb0b81e810 Add David badges to the README 2016-01-10 23:45:14 +00:00
Jérémie Astori
db99c3354b Add Travis CI badge to the README 2016-01-10 23:43:52 +00:00
Jan-Christoph Borchardt
936bb8141d fix development setup command, fix #535 2015-11-09 17:11:21 +01:00
JocelynDelalande
f172db7a99 Merge pull request #511 from olivierlambert/npm-scripts
add npm build script and update the doc accordingly
2015-10-08 11:01:49 +02:00
Olivier Lambert
9e98d01255 remove useless Grunt instruction in the doc 2015-10-07 14:51:00 +02:00
Jérémie Astori
dcc03786a2 Switch to SVG version of npm badge in the README 2015-10-07 02:26:29 +00:00
Olivier Lambert
aed3c2e271 add npm build script and update the doc accordingly 2015-10-06 12:42:22 +02:00
Paul Friederichsen
35bd5531cf Add font licensing to README.md 2015-10-06 02:55:30 -05:00
Mattias Erming
544c281bf6 Update README.md 2015-03-29 15:43:58 +02:00
Mattias Erming
baef7e0438 Update README.md 2015-03-29 15:42:16 +02:00
Jan-Christoph Borchardt
42a73f9b7b add development setup instructions, thanks @hennevogel, fix #355 2015-02-06 13:49:35 +01:00
Mattias Erming
fb61bdb1cb Update README.md 2014-10-01 21:10:14 +02:00