Commit 35aa363a authored by Gaurav Kapoor's avatar Gaurav Kapoor Committed by Gaurav Kapoor
Browse files

Issue #3265018 by gaurav.kapoor: Add a README file for the module and improve project description

parent 5b12d645
Loading
Loading
Loading
Loading

README.TXT

deleted100644 → 0
+0 −28
Original line number Diff line number Diff line
-------
COUNTER
-------
- Display Site Counter
- Display Clients IP
- Display Unique Visitor based on their IP Address
- You can set initial value for Counter
- Display node count
- Display user count

HOW TO START COUNTING
---------------------
To make Counter module start counting then you need to:

1. Enable the Counter block, or
2. If you want to count but don't want to show the Counter block then
   - go to Administer-Site Buiding-Counter Setting
   - set Show Site Counter Result for Administer group only = TRUE
   
THEMING
-------
CSS id="counter", i.e. to change text color to red then insert this code
to your style.css theme:

  #counter li {
    color: red;    
  }
  
 No newline at end of file

README.md

0 → 100644
+59 −0
Original line number Diff line number Diff line
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

Counter module collects request related information whenever website is
accessed and store it in the database. All the information is then
exposed to users via a block. The main statistics provided by the module
are:
  - Display Site Counter
  - Display Clients IP
  - Display Unique Visitor based on their IP Address
  - You can set initial value for Counter
  - Display node count
  - Display user count

* For a full description of the module, visit the project page:
  https://www.drupal.org/project/counter

* To submit bug reports and feature suggestions, or to track
  changes: https://www.drupal.org/project/issues/counter

REQUIREMENTS
------------

This module doesn't require any module outside of Drupal core.

CONFIGURATION
-------------

1. You can configure all the settings related to counter from 
('/admin/config/counter').

2. After that you can place the "Counter" block from the block layout and
check all the data by collected by this module.

3. You can also used data collected by Counter in a view by creating a new
view of type 'Counter'.

4. Make sure cron job provided by the module is configured to show the latest
data. In case, it has been disabled make sure you are invalidating
'counter_data_refresh' through any other custom logic.

MAINTAINERS
-----------

 * Gaurav Kapoor https://www.drupal.org/u/gauravkapoor

 Supporting organization:

 * Axelerant - https://www.drupal.org/axelerant