README.md 2.39 KB
Newer Older
Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
1 2 3 4 5 6
# Relevance

Relevance is a smart tab organizer for Chrome, written in ClojureScript.   

It’ll create a natural arrangement where the tabs you have spent the longest on, which are expected to be the most relevant, are placed first, and the ones you haven’t read at all are shunted to the end of your list.

7
[You can read more about it here](https://numergent.com/relevance/), which includes a changelog.
Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
8

9
This is Relevance 1.1.0-SNAPSHOT.
Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
10 11 12 13 14 15 16 17 18 19 20

# Building

## Development

To get a development build, run

```
lein chromebuild auto
```

21
You'll find the result in `target/unpacked/`, which you'll need to install into Chrome using developer mode.
Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

## Release

To get the release version, run

```
lein clean
lein with-profile release chromebuild zip
```


# Testing

Relevance uses `doo` for running ClojureScript tests. I normally use `phantomjs`, but you can use it with the [environment of your choice](https://github.com/bensu/doo#setting-up-environments).

We can't test the entire application externally, since a lot of its API depend on Chrome functions being present (which only happens when you're running as a Chrome extension).  You can however test the general functions running:

```
40
lein with-profile test doo
Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
41 42 43
```


Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
44 45 46 47
# Development

## Continuous integration

48
I'm using [Gitlab CI](https://gitlab.com/ricardojmendez/relevance/pipelines) to test Relevance.
Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
49

50
[![build status](https://gitlab.com/Numergent/relevance/badges/develop/build.svg)](https://gitlab.com/Numergent/relevance/commits/develop)
51 52

I've had some issues with Travis builds failing to get dependencies, so I decided to deprecate it.
Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
53 54 55

## Process

56
I'm using [git-flow](http://nvie.com/posts/a-successful-git-branching-model/). Pull requests are welcome. Please base them off the `develop` branch.
Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
57 58 59 60 61 62 63 64 65 66

## Version number conventions

Relevance uses [break versioning](https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md).

The development version on `project.clj` will reflect the current state of the code, and will normally include SNAPSHOT.

I can't update the package version from `manifest.json` to include alphanumerics, so that version will remain as the last public until I'm nearing a release (or need to test a data migration).


Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
67 68
# License

Ricardo J. Mendez's avatar
Ricardo J. Mendez committed
69 70
Includes pixeden's [iOS 7 vector icons](http://themes-pixeden.com/font-demos/7-stroke/).

71
Relevance is (c) 2016-2017 Numergent Limited, and released under the [MIT License](https://tldrlegal.com/license/mit-license).