Skip to content
This repository was archived by the owner on Aug 9, 2018. It is now read-only.

Commit db61e9c

Browse files
Update README in preparation for archiving
1 parent 11f5d8d commit db61e9c

File tree

1 file changed

+20
-23
lines changed

1 file changed

+20
-23
lines changed

README.md

+20-23
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
Run AngularJS apps on the server, using NodeJS.
44

5+
----
6+
7+
This package is **no longer maintained** and not recommended for use. While it did run in production at
8+
Say Media for several years, other approaches are now being used and this package is no longer being
9+
maintained for newer versions of AngularJS or Node.
10+
11+
The code is preserved here for posterity, in case anyone still wishes to use it, but we'd recommend
12+
instead considering [Angular Universal](https://angular.io/guide/universal) (for Angular 2, rather than
13+
AngularJS) or one of the various hosted services that can provide server-side rendering for single-page
14+
applications within their own infrastructure.
15+
16+
----
17+
518
## Introduction
619

720
[AngularJS](https://angularjs.org/) is an awesome framework for building rich single page applications.
@@ -208,13 +221,11 @@ but for the moment that is left as an exercise for the reader.
208221

209222
## Status
210223

211-
Parts of this codebase are currently in use in production on Say Media-run content sites like
212-
[Bio](http://biography.com/) and [xoVain](http://www.xovain.com/). However, the interface is not finalized and will
213-
evolve as we learn more about this problem space.
224+
Parts of this codebase were used in production on Say Media-run content sites. However, Say Media is no longer using
225+
AngularJS for this purpose and so this codebase is no longer used or maintained.
214226

215-
Therefore this codebase is currently shared primarily as an illustration of a possible strategy for making
216-
AngularJS-based sites robot-friendly, rather than as a ready-to-go solution. However, at the time of writing the following
217-
features are in use in production:
227+
This codebase was shared primarily as an illustration of a possible strategy for making AngularJS-based sites
228+
robot-friendly, rather than as a ready-to-go solution. However, the following features were used in production:
218229

219230
* All of the AngularJS service overrides in `ngoverrides.js`. These replace several key AngularJS services with more
220231
appropriate implementations for the server environment.
@@ -225,26 +236,12 @@ features are in use in production:
225236
* The `middlewareWithAngular` function, which decorates a connect middleware with code to spin up an AngularJS context
226237
and pass its injector as an extra parameter.
227238

228-
Variants of the remaining functions are in use in the Say Media content delivery platform, but their implementation has been
229-
modified beyond what is shown in this codebase. Once their implementations are more stable we intend to update this codebase,
230-
at which point the interface will almost certainly change.
231-
232-
In the mean time we welcome others to experiment with using AngularJS-Server on their own applications and share their
233-
experiences in [the AngularJS-Server Google Group](https://groups.google.com/forum/#!forum/angularjs-server).
239+
Variants of the remaining functions were used in the Say Media content delivery platform, but their implementation was
240+
modified beyond what is shown in this codebase.
234241

235242
## Contributing
236243

237244
Development environment setup is pretty standard: just clone the git repo and run `npm install`
238245
within it.
239246

240-
Contributions are welcome but are assumed to be licensed under the MIT license, as this package
241-
itself is. Please be sure to run the unit tests (such that they are) and the linter on your
242-
modified version, and then open a pull request.
243-
244-
```
245-
npm test
246-
npm run-script lint
247-
```
248-
249-
The project's code style is represented by the `.jshintrc` file but please also attempt to remain
250-
consistent with the prevailing style even if particular details *aren't* tested for by the linter.
247+
Since this package is no longer maintained, we are no longer able to accept contributions.

0 commit comments

Comments
 (0)