Skip to content

Commit cd1b78a

Browse files
committed
chore(README): Update in advance of 3.0 release
[skip ci]
1 parent 70fbc45 commit cd1b78a

File tree

1 file changed

+44
-22
lines changed

1 file changed

+44
-22
lines changed

README.md

Lines changed: 44 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66

77
# Help!
88

9-
Head to http://ui-grid.info for documentation and tutorials. Join https://gitter.im/angular-ui/ng-grid to discuss development of the 3.x codebase. We're always looking for new contributors, for pro-level contribution guidelines look at [Contributor](CONTRIBUTING.md), if you're more of a first-timer with open source (or just need a refresher), look at [First Time Open Source Contributor](FIRST_TIMER.md), also look at [Developer](DEVELOPER.md)
9+
Head to http://ui-grid.info for documentation and tutorials. Join https://gitter.im/angular-ui/ng-grid to discuss development and ask for specific help.
10+
11+
We're always looking for new contributors, for pro-level contribution guidelines look at [Contributor.md](CONTRIBUTING.md), if you're more of a first-timer with open source (or just need a refresher), look at [First Time Open Source Contributor.md](FIRST_TIMER.md), also look at [Developer.md](DEVELOPER.md)
1012

1113
# Installing
1214

@@ -32,26 +34,6 @@ Head to http://ui-grid.info for documentation and tutorials. Join https://gitter
3234
<script src="node_modules/angular-ui-grid/ui.grid.min.js">
3335
```
3436
35-
## Manual
36-
37-
If for some reason you want the latest release files here's some links:
38-
39-
File Name | Url
40-
---------------------|----------------
41-
ui-grid.js | [http://ui-grid.info/release/ui-grid.js](http://ui-grid.info/release/ui-grid.js)
42-
ui-grid.css | [http://ui-grid.info/release/ui-grid.css](http://ui-grid.info/release/ui-grid.css)
43-
ui-grid.eot | [http://ui-grid.info/release/ui-grid.eot](http://ui-grid.info/release/ui-grid.eot)
44-
ui-grid.svg | [http://ui-grid.info/release/ui-grid.svg](http://ui-grid.info/release/ui-grid.svg)
45-
ui-grid.ttf | [http://ui-grid.info/release/ui-grid.ttf](http://ui-grid.info/release/ui-grid.ttf)
46-
ui-grid.woff | [http://ui-grid.info/release/ui-grid.woff](http://ui-grid.info/release/ui-grid.woff)
47-
48-
There are minified files that can be used as well:
49-
50-
File Name | Url
51-
-------------------------|----------------
52-
ui-grid.min.js | [http://ui-grid.info/release/ui-grid.min.js](http://ui-grid.info/release/ui-grid.min.js)
53-
ui-grid.min.css | [http://ui-grid.info/release/ui-grid.min.css](http://ui-grid.info/release/ui-grid.min.css)
54-
5537
## CDN
5638
5739
You can use [rawgit.com](https://rawgit.com/)'s cdn url to access the files in the Bower repository. These files are hosted by [MaxCDN](https://www.maxcdn.com/). Just alter the version as you need.
@@ -61,7 +43,35 @@ You can use [rawgit.com](https://rawgit.com/)'s cdn url to access the files in t
6143
6244
# Angular Compatibility
6345
64-
UI-Grid is currently compatible with Angular versions ranging from 1.2.x to 1.3.x. 1.4.x+ support is coming soon.
46+
UI-Grid is currently compatible with Angular versions ranging from 1.2.x to 1.3.x.
47+
48+
1.4.x+ support is coming soon. If you would like to help please see issue #3658.
49+
50+
# Feature Stability
51+
52+
UI-Grid comes bundled with several features. Not all of them are currently stable. See the list below for the stability of each:
53+
54+
Feature | Release state
55+
------------------- | --------- |
56+
auto-resize-grid | beta
57+
cellnav | stable
58+
edit | stable
59+
expandable | alpha
60+
exporter | stable
61+
grouping | beta
62+
importer | stable
63+
infinite-scroll | beta
64+
move-columns | alpha
65+
pagination | alpha
66+
pinning | stable
67+
resize-columns | stable
68+
row-edit | stable
69+
saveState | stable
70+
selection | stable
71+
tree-base | beta
72+
tree-view | beta
73+
74+
For more details on the features check the [Tutorials](http://ui-grid.info/docs/#/tutorial).
6575
6676
# Building
6777
@@ -140,6 +150,18 @@ ui-grid is set up to run against SauceLabs. You must have the `SAUCE_ACCESS_KEY`
140150
141151
The full list of SauceLabs browsers can be seen by running `grunt saucebrowsers`. Usually it should suffice to let Travis do this testing automatically, unless you're trying to debug a browser-specific issue.
142152
153+
# What Happened to 2.x?
154+
155+
As of the 3.0 release, 2.x is officially deprecated. There will be no further releases. If for some reason you need to find the 2.x source please see the [2.x branch](https://github.com/angular-ui/ng-grid/tree/2.x).
156+
157+
# Repository Rename
158+
159+
With the 3.0 release, the repository has been renamed from "ng-grid" to "ui-grid".
160+
161+
All network traffic to GitHub should redirect automatically but they say you should update your git remote url:
162+
163+
git remote set-url origin https://github.com/angular-ui/ui-grid.git
164+
143165
# Thanks
144166
145167
Thanks to [Sauce Labs](http://saucelabs.com) and [BrowserStack](http://www.browserstack.com) for providing their testing platforms to open source projects for free.

0 commit comments

Comments
 (0)